1
0
mirror of synced 2025-12-25 11:03:37 -05:00
Files
docs/components
Tim Rogers 037d6328b8 Recommend an Accept header without V3 in it when documenting our REST API operations (#28477)
* Recommend an `Accept` header for REST API requests which doesn't mention V3

In the documentation for every REST API, in the "Headers"
section, we say for the `Accept` header that:

> Setting to `application/vnd.github.v3+json` is recommended.

Putting the V3 bit in doesn't actually do anything - in fact,
a high proportion of API consumers don't do it - and this
recommendation is going to be confusing once we launch our
new API versioning. This recommends that people use
`application/vnd.gitrhub+json` instead.

We could just recommend `application/json` - I'd be in favour
of that! - but I'm trying to make this change as small as
possible.

* Update cURL and GitHub CLI code examples to use an `Accept` header without V3

Co-authored-by: Sarah Edwards <skedwards88@github.com>
2022-06-29 15:50:07 +00:00
..
2022-03-14 08:25:48 -07:00
2021-09-30 20:22:13 +00:00

Components

⚠️ This area is a work-in-progress.

This is the main source for our React components. They can be rendered by the server or the client via Next.js. The starting point for any component usage is the pages/ directory, which uses a file-system routing paradigm to match paths to pages that then render these components.