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 - Initialize API Project
• 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

api_link

• create - Create API Link
• delete - Delete API Link
• get - Get API Link
• list - List API Links
• patch - Updates API Link
• reorder - Reorder API Links & Groups

api_link.group

• create - Create API Link Group
• delete - Delete API Link Group
• list - List API Link Groups
• patch - Update API Link Group

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 - GET /doc_project/{doc_name}/password

doc.theme

• get - Get Documentation Project Theme
• update - Update Documentation Project Theme

doc.version

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

doc.version.guide

• create - Create Guide
• delete - Delete Guide
• get - Get Guide
• get_content - Get Guide Content
• list - List Guides
• patch - Update Guide
• reorder - Reorder Guides

lint

• run - Lint OpenAPI

org

• create - Create Organization
• get - Get Organization

org.theme

• get - Get Organization Theme
• update - Update Organization Theme

role

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

sdk

• generate - Generate SDK
• list - List SDKs
• update - Update SDK

sdk.config

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

sdk.doc

• create - Get SDK Documentation

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