Skip to content

Commit

Permalink
Merge branch 'main' of github.com:github/rest-api-description into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Marc-Andre Giroux committed Jul 30, 2020
2 parents fb4ffc1 + 2de1cfc commit a6c95e0
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ This project is currently in **BETA**. We expect this description to be accurate

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 prefered 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 posssible, we also provide a fully dereferenced version of the description as well, without any references.
- 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

Expand Down

0 comments on commit a6c95e0

Please sign in to comment.