@octokit/openapi-webhooks
v8.3.0
Published
GitHub's official Webhooks OpenAPI spec with Octokit extensions
Downloads
480
Readme
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
- Install Octokit Release Notifier app
- 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