Sideko Managed SDKs Guide

Sideko Managed SDKs provide automatic updates to your SDKs whenever your OpenAPI specifications change. This guide will walk you through setting up and maintaining your SDKs using Sideko's automation tools.

Sideko utilizes git history to apply changes to sync your SDKs repositories. The /sdk/update endpoint simply returns a git patch file! This allows Sideko users to write custom code and documentation in the repos that are not overwritten in future SDK updates.

• Automatic SDK updates when OpenAPI specs change
• Flexible workflow integration (GitHub Actions, Bitbucket Pipelines, etc.)
• Customizable through OpenAPI x-fields or configuration files

sideko sdk init

This will guide you through creating your managed SDKs.

After generating your SDK:

1. Initialize a git repository for each SDK
2. Add your files
3. Commit changes
4. Push to your chosen source control platform

If using GitHub, set up the following repository secrets based on your SDK language:

• For Python SDKs:

  • Secret Name: PYPI_TOKEN
  • Purpose: Enables automatic publishing to PyPI

• For TypeScript SDKs:

  • Secret Name: NPM_TOKEN
  • Purpose: Enables automatic publishing to npm

• For Rust SDKs:

  • Secret Name: CRATES_IO_TOKEN
  • Purpose: Enables automatic publishing to crates.io

You can automate updates using the official Sideko GitHub Action.

 
# Triggers on any OpenAPI update
on:
  push:
    branches:
      - main
    paths:
      - openapi.yml
 
jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Sideko CLI
        shell: bash
        run: |
          curl -fsSL https://raw.githubusercontent.com/Sideko-Inc/sideko/main/install.sh | sh
 
      - name: Push Latest Spec
        run: |
           sideko api version create \
             --name my-api \
             --spec openapi.yml \
             --version patch
        env:
          SIDEKO_API_KEY: ${{ secrets.SIDEKO_API_KEY }}
 
      - uses: sideko-inc/sdk-update
        with:
          repo: your-org/client-py
          language: python
          sdk-version: patch
          github-token: ${{ secrets.SDK_GITHUB_TOKEN }}
          sideko-api-key: ${{ secrets.SIDEKO_SERVICE_ACCOUNT_KEY }}

If using Gitlab or Bitbucket, utilize the Sideko CLI to apply SDK updates using the sideko sdk update command.