Skip to content

Commit 1a95a47

Browse files
authored
feat: gitignore.getAllTemplates, licenses.getAllCommonlyUsed. Deprecates gitignore.listTemplates, licenses.listCommonlyUsed. (#130)
1 parent 57775f0 commit 1a95a47

File tree

19 files changed

+227
-70
lines changed

19 files changed

+227
-70
lines changed
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: List all codes of conduct
2+
name: Get all codes of conduct
33
example: octokit.codesOfConduct.getAllCodesOfConduct()
44
route: GET /codes_of_conduct
55
scope: codesOfConduct
66
type: API method
77
---
88

9-
# List all codes of conduct
9+
# Get all codes of conduct
1010

1111
```js
1212
octokit.codesOfConduct.getAllCodesOfConduct();
@@ -16,4 +16,4 @@ octokit.codesOfConduct.getAllCodesOfConduct();
1616

1717
This endpoint has no parameters
1818

19-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct).
19+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-all-codes-of-conduct).

docs/codesOfConduct/getConductCode.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get an individual code of conduct
2+
name: Get a code of conduct
33
example: octokit.codesOfConduct.getConductCode({ key })
44
route: GET /codes_of_conduct/{key}
55
scope: codesOfConduct
66
type: API method
77
---
88

9-
# Get an individual code of conduct
9+
# Get a code of conduct
1010

1111
```js
1212
octokit.codesOfConduct.getConductCode({
@@ -31,4 +31,4 @@ octokit.codesOfConduct.getConductCode({
3131
</tbody>
3232
</table>
3333

34-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct).
34+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-a-code-of-conduct).

docs/codesOfConduct/getForRepo.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get the contents of a repository's code of conduct
2+
name: Get the code of conduct for a repository
33
example: octokit.codesOfConduct.getForRepo({ owner, repo })
44
route: GET /repos/{owner}/{repo}/community/code_of_conduct
55
scope: codesOfConduct
66
type: API method
77
---
88

9-
# Get the contents of a repository's code of conduct
9+
# Get the code of conduct for a repository
1010

1111
This method returns the contents of the repository's code of conduct file, if one is detected.
1212

@@ -37,4 +37,4 @@ octokit.codesOfConduct.getForRepo({
3737
</tbody>
3838
</table>
3939

40-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct).
40+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-the-code-of-conduct-for-a-repository).

docs/codesOfConduct/listConductCodes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: List all codes of conduct
2+
name: Get all codes of conduct
33
example: octokit.codesOfConduct.listConductCodes()
44
route: GET /codes_of_conduct
55
scope: codesOfConduct
66
type: API method
77
---
88

9-
# List all codes of conduct
9+
# Get all codes of conduct
1010

1111
**Deprecated:** This method has been renamed to codesOfConduct.getAllCodesOfConduct
1212

@@ -18,4 +18,4 @@ octokit.codesOfConduct.listConductCodes();
1818

1919
This endpoint has no parameters
2020

21-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct).
21+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-all-codes-of-conduct).

docs/emojis/get.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get
2+
name: Get emojis
33
example: octokit.emojis.get()
44
route: GET /emojis
55
scope: emojis
66
type: API method
77
---
88

9-
# Get
9+
# Get emojis
1010

1111
Lists all the emojis available to use on GitHub.
1212

@@ -18,4 +18,4 @@ octokit.emojis.get();
1818

1919
This endpoint has no parameters
2020

21-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/emojis/#emojis).
21+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/emojis/#get-emojis).

docs/gitignore/getAllTemplates.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Get all gitignore templates
3+
example: octokit.gitignore.getAllTemplates()
4+
route: GET /gitignore/templates
5+
scope: gitignore
6+
type: API method
7+
---
8+
9+
# Get all gitignore templates
10+
11+
List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user).
12+
13+
```js
14+
octokit.gitignore.getAllTemplates();
15+
```
16+
17+
## Parameters
18+
19+
This endpoint has no parameters
20+
21+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#get-all-gitignore-templates).

docs/gitignore/getTemplate.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get a single template
2+
name: Get a gitignore template
33
example: octokit.gitignore.getTemplate({ name })
44
route: GET /gitignore/templates/{name}
55
scope: gitignore
66
type: API method
77
---
88

9-
# Get a single template
9+
# Get a gitignore template
1010

1111
The API also allows fetching the source of a single template.
1212

@@ -35,4 +35,4 @@ octokit.gitignore.getTemplate({
3535
</tbody>
3636
</table>
3737

38-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#get-a-single-template).
38+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#get-a-gitignore-template).

docs/gitignore/listTemplates.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
---
2-
name: Listing available templates
2+
name: Get all gitignore templates
33
example: octokit.gitignore.listTemplates()
44
route: GET /gitignore/templates
55
scope: gitignore
66
type: API method
77
---
88

9-
# Listing available templates
9+
# Get all gitignore templates
10+
11+
**Deprecated:** This method has been renamed to gitignore.getAllTemplates
1012

1113
List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create-a-repository-for-the-authenticated-user).
1214

@@ -18,4 +20,4 @@ octokit.gitignore.listTemplates();
1820

1921
This endpoint has no parameters
2022

21-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#listing-available-templates).
23+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#get-all-gitignore-templates).

docs/licenses/get.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
name: Get an individual license
2+
name: Get a license
33
example: octokit.licenses.get({ license })
44
route: GET /licenses/{license}
55
scope: licenses
66
type: API method
77
---
88

9-
# Get an individual license
9+
# Get a license
1010

1111
```js
1212
octokit.licenses.get({
@@ -31,4 +31,4 @@ octokit.licenses.get({
3131
</tbody>
3232
</table>
3333

34-
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-an-individual-license).
34+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-a-license).
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Get all commonly used licenses
3+
example: octokit.licenses.getAllCommonlyUsed()
4+
route: GET /licenses
5+
scope: licenses
6+
type: API method
7+
---
8+
9+
# Get all commonly used licenses
10+
11+
```js
12+
octokit.licenses.getAllCommonlyUsed();
13+
```
14+
15+
## Parameters
16+
17+
This endpoint has no parameters
18+
19+
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-all-commonly-used-licenses).

0 commit comments

Comments
 (0)