Skip to content

Commit d7a1082

Browse files
author
Marc-Andre Giroux
committed
Merge branch 'main' of github.com:github/rest-api-description into main
2 parents 5a25221 + ea3d873 commit d7a1082

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# GitHub's REST API OpenAPI Description
22

3-
This repository contains [OpenAPI](https://www.openapis.org/) descriptions for [GitHub's REST API](https://developer.github.com/v3/).
3+
This repository contains [OpenAPI](https://www.openapis.org/) descriptions for [GitHub's REST API](https://docs.github.com/rest).
44

55
## What is OpenAPI?
66

@@ -27,7 +27,7 @@ We use various vendor extensions for concepts that are harder to express with Op
2727

2828
- Not all headers are described in the OpenAPI documents, expect those to be added over time.
2929
- 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.
30-
- 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 opereations, but are working on a way to describe alias paths and/or describe all possible paths.
30+
- 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.
3131
- 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.
3232

3333
## Contributing

0 commit comments

Comments
 (0)