Skip to content

Commit a6c95e0

Browse files
author
Marc-Andre Giroux
committed
Merge branch 'main' of github.com:github/rest-api-description into main
2 parents fb4ffc1 + 2de1cfc commit a6c95e0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ This project is currently in **BETA**. We expect this description to be accurate
1616

1717
Each OpenAPI document is available in two formats: **bundled** and **dereferenced**.
1818

19-
- 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.
20-
- 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.
19+
- 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.
20+
- 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.
2121

2222
## Vendor Extensions
2323

0 commit comments

Comments
 (0)