Grace Park
320ffe6d01
Adding x-github-api-version header to js and cli examples ( #34935 )
2023-02-21 21:56:50 +00:00
Robert Sese
592ca1b51f
only set query params if method isn't GET or HEAD ( #34288 )
2023-02-02 17:09:25 +00:00
Rachael Sewell
89e507215a
account for non-object example values in rest docs ( #33469 )
...
Co-authored-by: Peter Bengtsson <peterbe@github.com >
2023-01-25 00:10:29 +00:00
Rachael Sewell
2fd7e0f451
Revert "account for non-object example values in rest docs" ( #33468 )
2022-12-12 20:14:36 +00:00
Rachael Sewell
e78eb192df
account for non-object example values in rest docs ( #33411 )
...
Co-authored-by: Robert Sese <734194+rsese@users.noreply.github.com >
2022-12-12 19:22:10 +00:00
Rachael Sewell
2724fb7b2a
add curl example for multipart form ( #33378 )
2022-12-09 19:34:22 +00:00
Grace Park
4103893460
Add x-github-api-version header to curl code examples ( #33203 )
2022-12-05 21:38:29 +00:00
Grace Park
a0536f8063
Add required query params to examples ( #32248 )
2022-11-10 21:17:34 +00:00
Rachael Sewell
93a3e80ede
Fix REST example copy-paste error ( #31043 )
2022-09-26 18:47:55 +00:00
Manuel Bergler
219638d7d4
Fix Management Console API code samples ( #30455 )
2022-09-06 15:58:04 +00:00
Grace Park
e75e6d3638
Add new line for gh cli for REST CodeSamples to work ( #30364 )
2022-08-30 19:53:14 +00:00
Sarah Edwards
148257a793
Make autogenerated REST examples work with JWTs ( #30352 )
2022-08-29 17:32:34 +00:00
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
