GitHub Actions

1

Create your Theneo documentation

Start by creating a documentation project in Theneo to house your API.

2

Set up the GitHub workflow

Add a file named Theneo.yml to .github/workflows/ in your repository, defining the action to run. Here's an example:

 
  name: Update Documentation
on:
  pull_request:
    branches:
      - main
jobs:
  update-doc:
    name: Update Theneo Documentation
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 Triggered by a ${{ github.event_name }} event."
      - name: Checkout
        uses: actions/checkout@v4
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "18"
      - name: Update Documentation on Theneo
        uses: Theneo-Inc/api-documentation@1.8.0
        with:
          FILE_PATH: doc/api.yml

          PROJECT_SLUG: <project_slug>
          VERSION_SLUG: <version_slug>
          WORKSPACE_SLUG: <workspace_slug>

          SECRET: ${{secrets.SECRET}}

          AUTO_PUBLISH: true

          IMPORT_OPTION: merge
          PARAMETER_DESCRIPTION_MERGE_STRATEGY: keep_new
          SECTION_DESCRIPTION_MERGE_STRATEGY: keep_old

          INCLUDE_GITHUB_METADATA: true

Theneo API Documentation on GitHub Marketplace

Get the official action and full details on the GitHub Marketplace.

3

Find your project slug

Open your project in Theneo — the slug is part of the URL: https://app.theneo.io/<workspace-name>/<project-slug>/[version-slug]. For example, in https://app.theneo.io/theneo/github-demo, the slug is github-demo. Use it for the PROJECT_SLUG input.

4

Configure the inputs

• FILE_PATH — path to your API documentation file in the repo.
• PROJECT_SLUG — your project's unique identifier in Theneo.
• VERSION_SLUG — import under a specific version (otherwise the default version is used).
• WORKSPACE_SLUG — import under a specific workspace.
• SECRET — your Theneo API token, from your Theneo profile.
• IMPORT_OPTION — how to handle the import: overwrite, merge, or endpoints.
• AUTO_PUBLISH — true publishes automatically; false lets you review in the editor first.
• INCLUDE_GITHUB_METADATA — include metadata like the GitHub actor (visible only in the Theneo editor).
• SECTION_DESCRIPTION_MERGE_STRATEGY — keep_new or keep_old for section descriptions.
• PARAMETER_DESCRIPTION_MERGE_STRATEGY — keep_new or keep_old for parameter descriptions.

5

Choose your import option

• overwrite — replace the current documentation with the new spec entirely.
• merge — attempt to merge changes (experimental; may append in some cases).
• endpoints — add new endpoints into a dedicated section for manual arrangement.

6

Set auto-publish

• true — automatically update the published docs with the latest changes.
• false — review in the editor before publishing.