1
0
mirror of synced 2025-12-23 11:54:18 -05:00
Commit Graph

7 Commits

Author SHA1 Message Date
Grace Park
0426962aec Fix single quote escaping for curl examples (#29876)
fix single quote escaping for curl examples
2022-08-11 22:26:58 +00:00
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
Rachael Sewell
dd6e60242b add token to curl examples (#28357) 2022-06-09 15:36:57 +00:00
Grace Park
3a88ec5f1f Add curl -h authorization header to REST API Code Samples (#28332)
* add curl -h authorization header

* move to get-rest-code-samples
2022-06-08 20:06:48 +00:00
Rachael Sewell
5f4f858b94 REST two-pane layout (#26954) 2022-05-02 10:10:33 -07:00
Robert Sese
2ee8aad472 Handle query parameters with PUT/POST operations (#26848)
Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com>
2022-04-12 14:36:50 -05:00
Rachael Sewell
02dbebbef3 render existing openapi examples (#26405) 2022-04-11 16:09:03 +00:00