rest-api-description

This release adds webhooks to our description!

In the 3.0.1 (./descriptions) version the webhooks are located at the top-level x-webhooks extension.

In the 3.1.0 version (./descriptions-next), which supports webhooks as an attribute on the OpenApi Object, they are located under webhooks.

Full Changelog: https://github.com/github/rest-api-description/compare/v2.0.0...v2.1.0

This release adds new, separates OpenAPI bundles for GitHub Enterprise Cloud (GHEC), with a normal and dereferenced version.

These bundled OpenAPI specifications will include all API operations available for GHEC customers on api.github.com, including GHEC-exclusive API operations and operations available to Free, Pro and Teams customers.

BREAKING CHANGE: Any API operations only available to GitHub Enterprise Cloud (GHEC) customers will no longer appear in the api.github.com OpenAPI specifications. These will only appear in the new GHEC-specific (ghec) OpenAPI specifications.

This is the first GA release of the OpenAPI description, conforming to the 3.0.1 specification. 🎉

What's Changed

• Added multiple new endpoints, including codespaces.
• Added new fields to existing responses as they've been introduced in the API.
• Remove false nullables
• Updated operation summary and descriptions
• Much more...

Full Changelog: https://github.com/github/rest-api-description/compare/v1.1.3...v1.1.4

This is a release candidate for v1.0.0 of our OpenAPI descriptions. This release includes the following changes:

• Added runner-group operations
• Removed machine-man preview
• Added SCIM operations
• Added code-scanning operations
• Removed sailor-v preview
• Updated various descriptions and examples
• Removed unhelpful descriptions
• Refactored some parameters to components
• Fixed schema inaccuracies from https://github.com/github/rest-api-description/issues/36
• Fixed invalid tag from https://github.com/github/rest-api-description/issues/38
• Released a new description for GHES-2.22

Cosmetic Changes

• Paths are now ordered alphabetically
• Request methods are ordered consistently

Bug Fixes

• Add missing path parameter to suspend user operation (#30)
• Fixes nullability issue with create-gist requestBody schema (#29)
• Fixes incorrect required key on event schema (#27)

• Adds a {protocol} server variable for GHES versions
• Removes the name requestBody parameter on the issues/update-label operation
• Fixes termsOfService and license top-level properties

• Fixes a few examples that were using a generic "string" value
• Fixes the info.version property on descriptions which stayed at 0.0.1 in the last release. Now at 0.0.3. Note that this is the document version, not the GitHub API version!

• Fixes issues in the YAML description around multi line strings
• Fixed invalid default property on the actions/create-workflow-dispatch operation.