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

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

GitHub Actions usage

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

name: Update OpenAPI
on:
  repository_dispatch:
    types: [octokit/openapi-webhooks release]

jobs:
  published:
    runs-on: ubuntu-latest
    steps:
      - run: "echo: 'new release: ${{ github.event.release.tag_name }}'"

Contributing

See CONTRIBUTING.md

License

MIT