Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@github/openapi
Advanced tools
Readme
The official OpenAPI descriptions for GitHub's REST API are now available at github.com/github/rest-api-description. Have a nice day!
This project houses the official OpenAPI definitions for GitHub's REST API, including the api.github.com
API and all currently supported GitHub Enterprise versions of the REST API.
๐ Here to use the OpenAPI schema? See Downloads
๐ Here to contribute? See CONTRIBUTING.md
OpenAPI (formerly Swagger) is an extension of JSON Schema that defines a standard, language-agnostic interface to RESTful APIs which allows both humans and computers to discover and understand the capabilities of an HTTP web service.
OpenAPI schemas are contracts that are useful both for API authors and API consumers. They can be used to produce API documentation, generate API clients (SDKs), run automated tests, validate API payloads, etc.
These definitions are used to generate GitHub's REST API reference documentation at docs.github.com/rest/reference.
These definitions will also soon be used to generate the JavaScript and Ruby Octokit client libraries. (This is a work in progress.)
This project is under active development and is rapidly evolving. To borrow from Slack's OpenAPI README:
We use a combination of internal metadata, custom scripting, and old fashioned writing-by-hand to produce these specifications. They don't always tell the whole truth and are subject to author and operator error. They are really useful though.
We use semantic versioning and conventional commit messages to ensure we're tracking breaking changes and releasing new major versions as necessary, but we cannot always be sure how changes might affect downstream consumers. If you are using these definitions, please be aware that they will change over time.
โ Before using these OpenAPI definitions, please read the project status.
You can download the latest api.github.com-deref.json
from unpkg.com or view all versions of the schema.
If you're using Node.js, you can download and install the @github/openapi
package using npm:
npm install @github/openapi
After installing the npm package, the raw schema files can be required directly:
const schema = require('@github/openapi/dist/api.github.com.json')
The package also exports a single object called schemas
that includes referenced and dereferenced variants of the schema for api.github.com and GitHub Enterprise:
const { schemas } = require('@github/openapi')
// {
// 'api.github.com-deref': {...},
// 'api.github.com': {...},
// 'ghe-2.18-deref': {...},
// 'ghe-2.18': {...},
// 'ghe-2.19-deref': {...},
// 'ghe-2.19': {...},
// 'ghe-2.20-deref': {...},
// 'ghe-2.20': {...},,
// 'ghe-2.21-deref': {...},
// 'ghe-2.21': {...}
// }
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!
FAQs
OpenAPI schema for GitHub's REST API
The npm package @github/openapi receives a total of 37 weekly downloads. As such, @github/openapi popularity was classified as not popular.
We found that @github/openapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago.ย It has 16 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.