openapi

GitHub's official Webhooks OpenAPI spec with Octokit extensions

Amends webhooks from GitHub's official OpenAPI specification with an x-octokit extension that includes the following keys

• changes: see change files in changes/

Download

Download from https://unpkg.com/browse/@octokit/openapi-webhooks/generated/

Node Usage

1const { schemas } = require("@octokit/openapi-webhooks");
2const version = schemas["api.github.com"].info.version;
3const paths = Object.keys(schemas["api.github.com"].paths).sort();

GitHub Actions usage

1. Install Octokit Release Notifier app
2. Create a new workflow file:

1name: Update OpenAPI
2on:
3  repository_dispatch:
4    types: [octokit/openapi-webhooks release]
5
6jobs:
7  published:
8    runs-on: ubuntu-latest
9    steps:
10      - run: "echo: 'new release: ${{ github.event.release.tag_name }}'"

Contributing

See CONTRIBUTING.md

License

MIT