GitHub's official OpenAPI spec with Octokit extensions
Amends operations from GitHub's official OpenAPI specification with an x-octokit
extension that includes the following keys
-
changes
: see change files in changes/
Download from https://unpkg.com/browse/@octokit/openapi/generated/
const { schemas } = require("@octokit/openapi");
const version = schemas["api.github.com"].info.version;
const paths = Object.keys(schemas["api.github.com"].paths).sort();
- Install Octokit Release Notifier app
- Create a new workflow file:
name: Update OpenAPI
on:
repository_dispatch:
types: [octokit/openapi release]
jobs:
published:
runs-on: ubuntu-latest
steps:
- run: "echo: 'new release: ${{ github.event.release.tag_name }}'"
See CONTRIBUTING.md