https://github.com/octokit/openapi
GitHub's official OpenAPI spec with Octokit extensions
https://github.com/octokit/openapi
hacktoberfest octokit-js openapi schema specification tooling
Last synced: 7 months ago
JSON representation
GitHub's official OpenAPI spec with Octokit extensions
- Host: GitHub
- URL: https://github.com/octokit/openapi
- Owner: octokit
- License: mit
- Created: 2020-11-27T22:15:05.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-28T12:05:10.000Z (8 months ago)
- Last Synced: 2025-05-28T13:19:22.762Z (8 months ago)
- Topics: hacktoberfest, octokit-js, openapi, schema, specification, tooling
- Language: JavaScript
- Homepage:
- Size: 403 MB
- Stars: 45
- Watchers: 8
- Forks: 10
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: changes/2020-09-17-operation-repos-actions-get-github-actions-permissions-repository.json
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# openapi
> GitHub's official OpenAPI spec with Octokit extensions
[](https://www.npmjs.com/package/@octokit/openapi)
Amends operations from [GitHub's official OpenAPI specification](https://github.com/github/rest-api-description/) with an `x-octokit` extension that includes the following keys
- `changes`: see change files in [changes/](changes/)
## Download
Download from https://unpkg.com/browse/@octokit/openapi/generated/
## Node Usage
```js
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](https://github.com/apps/octokit-release-notifier/)
2. Create a new workflow file:
```yml
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](CONTRIBUTING.md)
## License
[MIT](LICENSE)