Stainless

Automate your SDK example snippets in the API playground

Follow these steps to integrate Stainless with your Mintlify API documentation:

1. Add this to your Stainless config:

openapi.stainless.yml

openapi:
  code_samples: mintlify

2. Set up your OpenAPI configuration in Mintlify.

3. Create a GitHub Action to sync your OpenAPI spec between Stainless and your docs:

name: Sync OpenAPI Spec

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  stainless:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Upload to Stainless
        uses: stainless-api/upload-openapi-spec-action@main
        with:
          input_path: 'path/to/my-company-openapi.json'
          config_path: 'path/to/my-company.stainless.yaml'
          output_path: 'path/to/my-company-openapi.documented.json'
          project_name: 'my-stainless-project'
      - name: Sync to docs repo
        uses: dmnemec/copy_file_to_another_repo_action@main
        env:
          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
        with:
          source_file: 'config/my-company-openapi.documented.json'
          destination_repo: '{DOCS_REPO_NAME}'
          destination_folder: 'openapi-specs'
          user_email: '{EMAIL}'
          user_name: '{USERNAME}'
          commit_message: 'Auto-updates from Stainless'

Required GitHub Secrets:

• STAINLESS_API_KEY: Your Stainless API key
• API_TOKEN_GITHUB: GitHub Personal Access Token with repo access