Skip to content

Commit 3773081

Browse files
committed
Clarify parameter usage
1 parent b682b5c commit 3773081

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

content/v3.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,29 @@ All timestamps are returned in ISO 8601 format:
4040

4141
YYYY-MM-DDTHH:MM:SSZ
4242

43+
## Parameters
44+
45+
Many API methods take optional parameters. For GET requests, any parameters not
46+
specified as a segment in the path can be passed as an HTTP query string
47+
parameter:
48+
49+
<pre class="terminal">
50+
$ curl -i "https://api.github.com/repos/mojombo/jekyll/issues?state=closed"
51+
</pre>
52+
53+
In this example, the 'mojombo' and 'jekyll' values are provided for the `:user`
54+
and `:repo` parameters in the path while `:state` is passed in the query
55+
string.
56+
57+
For POST requests, parameters not included in the URL should be encoded as JSON
58+
with a Content-Type of 'application/x-www-form-urlencoded':
59+
60+
<pre class="terminal">
61+
$ curl -i -u username -d '{"scopes":["public_repo"]}' https://api.github.com/authorizations
62+
</pre>
63+
64+
65+
4366
## Client Errors
4467

4568
There are three possible types of client errors on API calls that

0 commit comments

Comments
 (0)