| Oct |
NOV |
Dec |
|
26 |
|
| 2023 |
2024 |
2025 |
About this capture
The Wayback Machine - http://web.archive.org/web/20241126205538/https://github.com/github/rest-api-description
Skip to content
Navigation Menu
●
GitHub Copilot
Write better code with AI
Security
Find and fix vulnerabilities
Actions
Automate any workflow
Codespaces
Instant dev environments
Issues
Plan and track work
Code Review
Manage code changes
Discussions
Collaborate outside of code
Code Search
Find more, search less
Explore
●
●
●
●
●
By company size
●
●
●
By use case
●
●
●
●
By industry
●
●
●
●
●
View all solutions
●
Topics
●
●
●
●
●
Explore
●
●
●
●
●
GitHub Sponsors
Fund open source developers
The ReadME Project
GitHub community articles
Repositories
●
●
●
●
Enterprise platform
AI-powered developer platform
Available add-ons
Advanced Security
Enterprise-grade security features
GitHub Copilot
Enterprise-grade AI features
Premium Support
Enterprise-grade 24/7 support
●
Search or jump to...
Clear
Search syntax tips
Provide feedback
Saved searches
Use saved searches to filter your results more quickly
To see all available qualifiers, see our documentation.
focus
You signed in with another tab or window. Reload to refresh your session.
You signed out in another tab or window. Reload to refresh your session.
You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
{{ message }}
github
/
rest-api-description
Public
●
Notifications
You must be signed in to change notification settings
●
Fork
235
Star
1.4k
An OpenAPI description for GitHub's REST API
License
MIT license
1.4k
stars
235
forks
Branches
Tags
Activity
Star
Notifications
You must be signed in to change notification settings
●
Code
●
Issues
144
●
Pull requests
0
●
Discussions
●
Actions
●
Security
●
Insights
Additional navigation options
●
Code
●
Issues
●
Pull requests
●
Discussions
●
Actions
●
Security
●
Insights
github/rest-api-description
main
BranchesTags
Folders and files
| Name | Name |
Last commit message
|
Last commit date
|
|---|
Latest commit
History
2,654 Commits
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Repository files navigation
●README
●Code of conduct
●MIT license
●Security
GitHub's REST API OpenAPI Description
This repository contains OpenAPI descriptions for GitHub's REST API.
What is OpenAPI?
From the OpenAPI Specification:
The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs, which allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional documentation, or inspection of network traffic. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service.
Project Status
As of the 1.1.4 release, this description is considered stable and generally available.
The descriptions folder contains the 3.0 version of the description.
The descriptions-next folder contains the 3.1 version of the description, and is subject to breaking changes on the main branch.
Description Formats
Each OpenAPI document is available in two formats: bundled and dereferenced.
●The bundled descriptions are single file artifacts that make usages of OpenAPI components for reuse and portability. This is the preferred way of interacting with GitHub's OpenAPI description.
●Certain tools have poor support for references to components within the artifact. We highly encourage to look into tooling that supports referenced components, but since that's not always possible, we also provide a fully dereferenced version of the description as well, without any references.
Vendor Extensions
We use various vendor extensions for concepts that are harder to express with OpenAPI components and/or are specific to GitHub. For more information on the extensions used in these description, check out extensions.md
Limitations
●Not all headers are described in the OpenAPI documents, expect those to be added over time.
●Certain GitHub API resources use multi segment path parameters, which aren't supported by the OpenAPI specification. For the time being, we have annotated such parameters with a x-multi-segment extension. In general, URL encoding those parameters is a good idea.
●A lot of operations described in these documents are accessible through multiple paths. For the time being we have described the most common way to access these operations, but are working on a way to describe alias paths and/or describe all possible paths.
●This repository only contains the bundled and dereferenced versions of our REST API descriptions. We're looking into offering a fully referenced directory structure for easier browsing.
Contributing
Because this description is used across GitHub's whole API development experience, we don't currently accept pull requests that directly modify the description. This repository is automatically kept up to date with the description used to validate GitHub API requests as well as powering contract tests. See CONTRIBUTING.md for more details.
If you've identified a mismatch between GitHub API's behavior and these descriptions, or found an issue with the format of a schema, please open an issue.
License
github/rest-api-description is licensed under the MIT license
Contact
You may contact opensource+rest-api-description@github.com with any questions related to this repository.
About
An OpenAPI description for GitHub's REST API
Resources
Readme
License
MIT license
Code of conduct
Code of conduct
Security policy
Security policy
Activity
Custom properties
Stars
1.4k
stars
Watchers
54
watching
Forks
235
forks
Report repository
v2.1.0
Latest
Oct 25, 2022
+ 16 releases
+ 9 contributors
Footer
© 2024 GitHub, Inc.
●
Terms
●
Privacy
●
Security
●
Status
●
Docs
●
Contact
●
●
ation
You can’t perform that action at this time.
