Skip to content

Commit 7e39d4a

Browse files
gjtorikiangjtorikian
committed
Convert repos
1 parent 52c5f60 commit 7e39d4a

9 files changed

Lines changed: 193 additions & 358 deletions

File tree

‎content/v3/repos.md‎

Lines changed: 44 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,12 @@ separately.
1919

2020
### Parameters
2121

22-
type
23-
: `all`, `owner`, `public`, `private`, `member`. Default: `all`.
22+
Name | Type | Description | Required? | Default
23+
-----|------|--------------|----------|---------
24+
`type`|`string` | Can be one of `all`, `owner`, `public`, `private`, `member`. | |`all`
25+
`sort`|`string` | Can be one of `created`, `updated`, `pushed`, `full_name`. | |`full_name`
26+
`direction`|`string` | Can be one of `asc` or `desc`. | |When using `full_name`: `asc`; otherwise `desc`
2427

25-
sort
26-
: `created`, `updated`, `pushed`, `full_name`, default: `full_name`.
27-
28-
direction
29-
: `asc` or `desc`, default: when using `full_name`: `asc`, otherwise `desc`.
3028

3129
## List user repositories
3230

@@ -36,14 +34,12 @@ List public repositories for the specified user.
3634

3735
### Parameters
3836

39-
type
40-
: `all`, `owner`, `member`. Default: `all`.
41-
42-
sort
43-
: `created`, `updated`, `pushed`, `full_name`, default: `full_name`.
37+
Name | Type | Description | Required? | Default
38+
-----|------|--------------|----------|---------
39+
`type`|`string` | Can be one of `all`, `owner`, `member`. | |`all`
40+
`sort`|`string` | Can be one of `created`, `updated`, `pushed`, `full_name`. | |`full_name`
41+
`direction`|`string` | Can be one of `asc` or `desc`. | |When using `full_name`: `asc`, otherwise `desc`
4442

45-
direction
46-
: `asc` or `desc`, default: when using `full_name`: `asc`, otherwise `desc`.
4743

4844
## List organization repositories
4945

@@ -53,8 +49,10 @@ List repositories for the specified org.
5349

5450
### Parameters
5551

56-
type
57-
: `all`, `public`, `private`, `forks`, `sources`, `member`. Default: `all`.
52+
Name | Type | Description | Required? | Default
53+
-----|------|--------------|----------|---------
54+
`type`|`string` | Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`. | |`all`
55+
5856

5957
### Response
6058

@@ -73,8 +71,10 @@ repositories.
7371

7472
### Parameters
7573

76-
since
77-
: The integer ID of the last Repository that you've seen.
74+
Name | Type | Description | Required? | Default
75+
-----|------|--------------|----------|---------
76+
`since`| | The integer ID of the last Repository that you've seen.| |
77+
7878

7979
### Response
8080

@@ -95,46 +95,19 @@ be a member of the specified organization.
9595

9696
### Input
9797

98-
name
99-
: _Required_ **string**
100-
101-
description
102-
: _Optional_ **string**
103-
104-
homepage
105-
: _Optional_ **string**
106-
107-
private
108-
: _Optional_ **boolean** - `true` to create a private repository, `false`
109-
to create a public one. Creating private repositories requires a paid
110-
GitHub account. Default is `false`.
111-
112-
has\_issues
113-
: _Optional_ **boolean** - `true` to enable issues for this repository,
114-
`false` to disable them. Default is `true`.
115-
116-
has\_wiki
117-
: _Optional_ **boolean** - `true` to enable the wiki for this
118-
repository, `false` to disable it. Default is `true`.
119-
120-
has\_downloads
121-
: _Optional_ **boolean** - `true` to enable downloads for this
122-
repository, `false` to disable them. Default is `true`.
98+
Name | Type | Description | Required? | Default
99+
-----|------|--------------|----------|---------
100+
`name`|`string` | The name of the repository|**YES**|
101+
`description`|`string` | A short description of the repository| |
102+
`homepage`|`string` | A URL with more information about the repository| |
103+
`private`|`boolean` | Either `true` to create a private repository, or `false` to create a public one. Creating private repositories requires a paid GitHub account. | |`false`
104+
`has_issues`|`boolean` | Either `true` to enable issues for this repository, `false` to disable them. | |`true`
105+
`has_wiki`|`boolean` | Either `true` to enable the wiki for this repository, `false` to disable it. | |`true`
106+
`has_downloads`|`boolean` | Either `true` to enable downloads for this repository, `false` to disable them. | |`true`
107+
`team_id`|`number` | The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.| |
108+
`auto_init`|`boolean` | Pass `true` to create an initial commit with empty README. | |`false`
109+
`gitignore_template`|`string` | Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, "Haskell". _Ignored if the `auto_init` parameter is not provided._| |
123110

124-
team\_id
125-
: _Optional_ **number** - The id of the team that will be granted access
126-
to this repository. This is only valid when creating a repo in an
127-
organization.
128-
129-
auto\_init
130-
: _Optional_ **boolean** - `true` to create an initial commit with empty
131-
README. Default is `false`.
132-
133-
gitignore\_template
134-
: _Optional_ **string** - Desired language or platform [.gitignore
135-
template](https://github.com/github/gitignore) to
136-
apply. Use the name of the template without the extension. For example, "Haskell"
137-
_Ignored if `auto_init` parameter is not provided._
138111

139112
<%= json \
140113
:name => "Hello-World",
@@ -172,33 +145,17 @@ The `parent` and `source` objects are present when the repo is a fork.
172145

173146
### Input
174147

175-
name
176-
: _Required_ **string**
177-
178-
description
179-
: _Optional_ **string**
180-
181-
homepage
182-
: _Optional_ **string**
183-
184-
private
185-
: _Optional_ **boolean** - `true` makes the repository private, and
186-
`false` makes it public.
148+
Name | Type | Description | Required? | Default
149+
-----|------|--------------|----------|---------
150+
`name`|`string` | The name of the repository|**YES**|
151+
`description`|`string` | A short description of the repository| |
152+
`homepage`|`string` | A URL with more information about the repository| |
153+
`private`|`boolean` | Either `true` to make the repository private, or `false` to make it public. Creating private repositories requires a paid GitHub account. | |`false`
154+
`has_issues`|`boolean` | Either `true` to enable issues for this repository, `false` to disable them. | |`true`
155+
`has_wiki`|`boolean` | Either `true` to enable the wiki for this repository, `false` to disable it. | |`true`
156+
`has_downloads`|`boolean` | Either `true` to enable downloads for this repository, `false` to disable them. | |`true`
157+
`default_branch`|`String` | Updates the default branch for this repository.| |
187158

188-
has\_issues
189-
: _Optional_ **boolean** - `true` to enable issues for this repository,
190-
`false` to disable them. Default is `true`.
191-
192-
has\_wiki
193-
: _Optional_ **boolean** - `true` to enable the wiki for this
194-
repository, `false` to disable it. Default is `true`.
195-
196-
has\_downloads
197-
: _Optional_ **boolean** - `true` to enable downloads for this
198-
repository, `false` to disable them. Default is `true`.
199-
200-
default\_branch
201-
: _Optional_ **String** - Update the default branch for this repository.
202159

203160
<%= json \
204161
:name => "Hello-World",
@@ -221,9 +178,10 @@ default\_branch
221178

222179
### Parameters
223180

224-
anon
225-
: Optional flag. Set to `1` or `true` to include anonymous contributors
226-
in results.
181+
Name | Type | Description | Required? | Default
182+
-----|------|--------------|----------|---------
183+
`anon`|`string` | Set to `1` or `true` to include anonymous contributors in results.| |
184+
227185

228186
### Response
229187

‎content/v3/repos/comments.md‎

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -36,21 +36,14 @@ Comments are ordered by ascending ID.
3636

3737
### Input
3838

39-
sha
40-
: _Required_ **string** - SHA of the commit to comment on.
39+
Name | Type | Description | Required? | Default
40+
-----|------|--------------|----------|---------
41+
`sha`|`string` | The SHA of the commit to comment on.|**YES**|
42+
`body`|`string` | The contents of the comment.|**YES**|
43+
`path`|`string` | Relative path of the file to comment on.| |
44+
`position`|`number` | Line index in the diff to comment on.| |
45+
`line`|`number` | **Deprecated**. Use **position** parameter instead. Line number in the file to comment on. | |`null`
4146

42-
body
43-
: _Required_ **string**
44-
45-
path
46-
: _Optional_ **string** - Relative path of the file to comment on.
47-
48-
position
49-
: _Optional_ **number** - Line index in the diff to comment on.
50-
51-
line
52-
: _Deprecated_ - Use **position** parameter instead.
53-
: _Optional_ **number** - Line number in the file to comment on. Defaults to `null`.
5447

5548
#### Example
5649

@@ -81,8 +74,10 @@ line
8174

8275
### Input
8376

84-
body
85-
: _Required_ **string**
77+
Name | Type | Description | Required? | Default
78+
-----|------|--------------|----------|---------
79+
`body`|`string` | The contents of the comment|**YES**|
80+
8681

8782
#### Example
8883

‎content/v3/repos/commits.md‎

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,14 @@ instead of constructing page links yourself.
2020

2121
### Parameters
2222

23-
sha
24-
: _Optional_ **string** - Sha or branch to start listing commits from.
23+
Name | Type | Description | Required? | Default
24+
-----|------|--------------|----------|---------
25+
`sha`|`string` | SHA or branch to start listing commits from.| |
26+
`path`|`string` | Only commits containing this file path will be returned.| |
27+
`author`|`string` | GitHub login, name, or email by which to filter by commit author| |
28+
`since`|`time` | The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only commits after this date will be returned| |
29+
`until`|`time` | The time should be passed in as UTC in the ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Only commits before this date will be returned| |
2530

26-
path
27-
: _Optional_ **string** - Only commits containing this file path
28-
will be returned.
29-
30-
author
31-
: _Optional_ **string** - GitHub login, name, or email by which to filter by
32-
commit author
33-
34-
since
35-
: _Optional_ **ISO 8601 Date** - Only commits after this date will be returned
36-
37-
until
38-
: _Optional_ **ISO 8601 Date** - Only commits before this date will be returned
3931

4032
### Response
4133

0 commit comments

Comments
 (0)