Generate Stripe-like API Documentation

Get Started Today

Table of contents

• Usage
• Inputs
• Contributing
• Licence

Usage

Start by creating a documentation on Theneo. Then add following workflow file to your GitHub project .github/workflows/Theneo.yml. On every push request theneo documentation will be updated.

Update documentation on pull request

Update api documentation on push.

name: Update documention
on:
  pull_request:
    branches:
      - main
jobs:
  update-doc:
    name: update theneo doc
    runs-on: ubuntu-latest
    steps:
      - run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: "18"
      - name: process documentation on server
        uses: Theneo-Inc/api-documentation@1.7.0
        with:
          FILE_PATH: doc/api.yml
          PROJECT_KEY: ${{secrets.PROJECT_KEY}}
          SECRET: ${{secrets.SECRET}}
          IMPORT_OPTION: overwrite
          AUTO_PUBLISH: false
          INCLUDE_GITHUB_METADATA: true

make sure to update path with your document path, PROJECT_KEY with project key, SECRET with GitHub secret

Inputs

• FILE_PATH (required): path to your documentation file within repository.
• PROJECT_KEY (required): unique identifier of project, it can be found under project settings for existing project.
• SECRET (required): Theneo API token to authenticate GitHub request, displayed under user profile.
• IMPORT_OPTION (optional): import option should be one of (overwrite, merge, endpoints, append), by default overwrite will be used.
• AUTO_PUBLISH (optional): Indicates if the documentation should be published automatically or not after importing.
• INCLUDE_GITHUB_METADATA (optional): Indicates if the imported documentation should include GitHub metadata (such as GitHub actor) or not - only visible in Theneo's editor.

deprecated inputs

• PATH - instead use FILE_PATH

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/theneoAPIDoc/api-documentation. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The scripts and documentation in this project are released under the MIT License.