885da5b3d3
* New Crowdin translations by Github Action * Reset broken translated files to English * Ran script/i18n/homogenize-frontmatter.js * Ran script/fix-translation-errors.js * Reverted translated files with parsing and rendering errors * fix malformed liquid * add next directory to exclude list * currentversion -> currentVersion * fix liquid errors * fix liquid errors * Reset broken translated files to English * Ran script/i18n/homogenize-frontmatter.js * Revert /ja/github/authenticating-to-github/about-authentication-with-saml-single-sign-on * Reset known broken translation files LAST * Run script/i18n/homogenize-frontmatter.js Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
1.7 KiB
title, intro, versions, topics
| title | intro | versions | topics | |||||
|---|---|---|---|---|---|---|---|---|
| OpenAPI description | The {% data variables.product.product_name %} REST API is fully described in an OpenAPI 3.0 compliant document. |
|
|
About OpenAPI descriptions
OpenAPI is a standard specification for describing REST APIs. OpenAPI descriptions allow both humans and machines to discover the capabilities of an API without needing to first read documentation or understand the implementation. {% data variables.product.company_short %} has made its REST API publicly available as an OpenAPI 3.0 compliant document.
Getting the {% data variables.product.company_short %} OpenAPI description
You can find the description in the open source REST API OpenAPI Description repository.
We provide the description in two formats. The bundled version works for most cases, as it includes OpenAPI components for reuse and readability. If your tooling does not support inline references to components, we also provide a fully dereferenced version.
Using the {% data variables.product.company_short %} OpenAPI description
There are many uses for an OpenAPI description. For example, you could:
- Generate your own API client.
- Validate and test a {% data variables.product.company_short %} REST API integration.
- Explore and interact with the {% data variables.product.product_name %} REST API using third-party tools, such as Insomnia or Postman.
For example, {% data variables.product.company_short %} uses the REST OpenAPI description to generate the {% data variables.product.product_name %} REST API reference documentation.