Skip to content

Commit 67be00a

Browse files
committed
Convert gists
1 parent f17ae1e commit 67be00a

2 files changed

Lines changed: 18 additions & 29 deletions

File tree

content/v3/gists.md

Lines changed: 16 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,10 @@ List the authenticated user's starred gists:
3636

3737
### Parameters
3838

39-
since
40-
: _Optional_ **string** of a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
41-
Only gists updated at or after this time are returned.
39+
Name | Type | Description | Required? | Default
40+
----|------|--------------|-----------|---------
41+
`since`|`string` | A timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.| |
42+
4243

4344
### Response
4445

@@ -62,19 +63,13 @@ _Note_: When using the [v3 media type][2] the "user" field will become "owner"
6263

6364
### Input
6465

65-
description
66-
: _Optional_ **string**
67-
68-
public
69-
: _Optional_ **boolean** - Default: `false`.
70-
71-
files
72-
: _Required_ **hash** - Files that make up this gist. The key of which
73-
should be a _required_ **string** filename and the value another
74-
_required_ **hash** with parameters:
66+
Name | Type | Description | Required? | Default
67+
----|------|--------------|-----------|---------
68+
`description`|`string` | A description of the gist.| |
69+
`public`|`boolean` | Indicates whether the gist is public. | |`false`
70+
`files`|`hash` | Files that make up this gist.|**YES**|
7571

76-
content
77-
: _Required_ **string** - File contents.
72+
The keys in the `files` hash are the `string` filename, and the value is another `hash` with a key of `contents`, and a value of the file contents. For example:
7873

7974
<%= json \
8075
:description => "the description for this gist",
@@ -98,19 +93,13 @@ format of the automatic naming scheme that Gist uses internally.
9893

9994
### Input
10095

101-
description
102-
: _Optional_ **string**
103-
104-
files
105-
: _Optional_ **hash** - Files that make up this gist. The key of which
106-
should be an _optional_ **string** filename and the value another
107-
_optional_ **hash** with parameters:
108-
109-
content
110-
: _Optional_ **string** - Updated file contents.
96+
Name | Type | Description | Required? | Default
97+
----|------|--------------|-----------|---------
98+
`description`|`string` | A description of the gist.| |
99+
`files`|`hash` | Files that make up this gist. The key of which should be an _optional_ **string** filename and the value another _optional_ **hash** with parameters:| |
100+
`content`|`string` | Updated file contents.| |
101+
`filename`|`string` | New name for this file.| |
111102

112-
filename
113-
: _Optional_ **string** - New name for this file.
114103

115104
NOTE: All files from the previous version of the gist are carried over by
116105
default if not included in the hash. Deletes can be performed by

content/v3/gists/comments.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ You can read more about the use of media types in the API
3737

3838
Name | Type | Description | Required? | Default
3939
----|------|--------------|-----------|---------
40-
`body`|`string` | The contents of the gist|**YES**|
40+
`body`|`string` | The comment text.|**YES**|
4141

4242

4343
<%= json :body => 'Just commenting for the sake of commenting' %>
@@ -56,7 +56,7 @@ Name | Type | Description | Required? | Default
5656

5757
Name | Type | Description | Required? | Default
5858
----|------|--------------|-----------|---------
59-
`body`|`string` | The contents of the gist|**YES**|
59+
`body`|`string` | The comment text.|**YES**|
6060

6161

6262
<%= json :body => 'Just commenting for the sake of commenting' %>

0 commit comments

Comments
 (0)