Sideko REST API Rust SDK

Overview

The Sideko API unlocks features including generating SDKs, setting up API Specifications with mock servers, creating documentation projects with generated API references and custom pages, managing roles and permissions, and more.

Example Client Initialization

let client = sideko_rest_api::Client::default()
    .with_api_key_auth(&std::env::var("API_KEY").unwrap())
    .with_cookie_auth(&std::env::var("API_KEY").unwrap());

Module Documentation and Snippets

api

• create - Create API Project
• delete - Delete API Project
• get - Get API Project
• init - Create API Project with OpenAPI
• list - List API Projects

api.spec

• create - Create API Version
• delete - Delete API Version
• get - Get API Version
• get_openapi - Get OpenAPI
• get_stats - Get Spec Stats
• list - List API Versions
• patch - Update API Version

asset

• create - Upload Asset
• delete - Delete Asset
• list - List Assets
• patch - Update Asset

auth

• exchange_code - Exchange Code

cli

• check_updates - Check for CLI Updates

doc

• check_preview - Check Preview Access
• create - Create Documentation Project
• delete - Delete Documentation Project
• get - Get Documentation Project
• list - List Documentation Projects
• patch - Update Documentation Project

doc.deployment

• get - Get Documentation Deployment
• list - List Documentation Deployments
• trigger - Trigger Documentation Deployment

doc.preview

• create_password - Create Preview Password
• delete_password - Deletes Preview Password
• list_passwords - List Preview Passwords

doc.version

• get - Get Documentation Project Version
• list - List Documentation Project Versions

doc.version.api_link

• get - Get API Link
• patch - Update API Link

doc.version.dropdown

• patch - Update Dropdown

doc.version.external_link

• patch - Update External Link

doc.version.page

• get - Get Page
• patch - Update Page

doc.version.sidebar

• create_item - Create Sidebar Item
• delete_item - Delete Sidebar Item
• list_items - List Sidebar Items
• reorder - Reorder Sidebar

doc.version.space

• patch - Update Space

doc.version.title

• patch - Update Title

doc.version.topbar

• create_item - Create Topbar Item
• delete_item - Delete Topbar Item
• list_items - List Topbar Items
• reorder - Reorder Topbar

lint

• run - Lint OpenAPI

org

• create - Create Organization
• get - Get Organization

role

• create - Create New Role
• delete - Delete Role
• list - List Roles

sdk

• generate - Generate SDK
• generate_and_push - Generate an SDK and automatically push to the linked version control system
• list - List SDKs
• update - Update SDK

sdk.config

• init - Initialize SDK Configuration
• sync - Sync SDK Configuration

sdk.doc

• create - Get SDK Documentation

sdk.metadata

• update - Update the metadata of an SDK

service_account

• create - Create Service Account
• delete - Delete Service Account
• get - Get Service Account
• list - List Service Accounts

user

• invite - Invite User

user.me

• get - Get Current User
• get_key - Get API Key