Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.13 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.13 KB
Raw

openapi

GitHub's official OpenAPI spec with Octokit extensions

@latest

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

Download

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

Node Usage

const { schemas } = require("@octokit/openapi");
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 release]

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

Contributing

See CONTRIBUTING.md

License

MIT