We're looking into offering a fully referenced directory structure for easier browsing.īecause 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 only contains the bundled and dereferenced versions of our REST API descriptions.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. A lot of operations described in these documents are accessible through multiple paths.In general, URL encoding those parameters is a good idea. For the time being, we have annotated such parameters with a x-multi-segment extension. Certain GitHub API resources use multi segment path parameters, which aren't supported by the OpenAPI specification.Not all headers are described in the OpenAPI documents, expect those to be added over time.For more information on the extensions used in these description, check out extensions.md Limitations We use various vendor extensions for concepts that are harder to express with OpenAPI components and/or are specific to GitHub. 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. Certain tools have poor support for references to components within the artifact.This is the preferred way of interacting with GitHub's OpenAPI description. The bundled descriptions are single file artifacts that make usages of OpenAPI components for reuse and portability.Description FormatsĮach OpenAPI document is available in two formats: bundled and dereferenced. The descriptions-next folder contains the 3.1 version of the description, and is subject to breaking changes on the main branch. The descriptions folder contains the 3.0 version of the description. Project StatusĪs of the 1.1.4 release, this description is considered stable and generally available. Similar to what interface descriptions have done for lower-level programming, the OpenAPI Specification removes guesswork in calling a service. When properly defined via OpenAPI, a consumer can understand and interact with the remote service with a minimal amount of implementation logic. 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. This repository contains OpenAPI descriptions for GitHub's REST API.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |