Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/codesOfConduct/getAllCodesOfConduct.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: List all codes of conduct
name: Get all codes of conduct
example: octokit.codesOfConduct.getAllCodesOfConduct()
route: GET /codes_of_conduct
scope: codesOfConduct
type: API method
---

# List all codes of conduct
# Get all codes of conduct

```js
octokit.codesOfConduct.getAllCodesOfConduct();
Expand All @@ -16,4 +16,4 @@ octokit.codesOfConduct.getAllCodesOfConduct();

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-all-codes-of-conduct).
6 changes: 3 additions & 3 deletions docs/codesOfConduct/getConductCode.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Get an individual code of conduct
name: Get a code of conduct
example: octokit.codesOfConduct.getConductCode({ key })
route: GET /codes_of_conduct/{key}
scope: codesOfConduct
type: API method
---

# Get an individual code of conduct
# Get a code of conduct

```js
octokit.codesOfConduct.getConductCode({
Expand All @@ -31,4 +31,4 @@ octokit.codesOfConduct.getConductCode({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-a-code-of-conduct).
6 changes: 3 additions & 3 deletions docs/codesOfConduct/getForRepo.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Get the contents of a repository's code of conduct
name: Get the code of conduct for a repository
example: octokit.codesOfConduct.getForRepo({ owner, repo })
route: GET /repos/{owner}/{repo}/community/code_of_conduct
scope: codesOfConduct
type: API method
---

# Get the contents of a repository's code of conduct
# Get the code of conduct for a repository

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

Expand Down Expand Up @@ -37,4 +37,4 @@ octokit.codesOfConduct.getForRepo({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-the-code-of-conduct-for-a-repository).
6 changes: 3 additions & 3 deletions docs/codesOfConduct/listConductCodes.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: List all codes of conduct
name: Get all codes of conduct
example: octokit.codesOfConduct.listConductCodes()
route: GET /codes_of_conduct
scope: codesOfConduct
type: API method
---

# List all codes of conduct
# Get all codes of conduct

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

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

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/codes_of_conduct/#get-all-codes-of-conduct).
6 changes: 3 additions & 3 deletions docs/emojis/get.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Get
name: Get emojis
example: octokit.emojis.get()
route: GET /emojis
scope: emojis
type: API method
---

# Get
# Get emojis

Lists all the emojis available to use on GitHub.

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

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/emojis/#emojis).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/emojis/#get-emojis).
21 changes: 21 additions & 0 deletions docs/gitignore/getAllTemplates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Get all gitignore templates
example: octokit.gitignore.getAllTemplates()
route: GET /gitignore/templates
scope: gitignore
type: API method
---

# Get all gitignore templates

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).

```js
octokit.gitignore.getAllTemplates();
```

## Parameters

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#get-all-gitignore-templates).
6 changes: 3 additions & 3 deletions docs/gitignore/getTemplate.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Get a single template
name: Get a gitignore template
example: octokit.gitignore.getTemplate({ name })
route: GET /gitignore/templates/{name}
scope: gitignore
type: API method
---

# Get a single template
# Get a gitignore template

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

Expand Down Expand Up @@ -35,4 +35,4 @@ octokit.gitignore.getTemplate({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#get-a-single-template).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#get-a-gitignore-template).
8 changes: 5 additions & 3 deletions docs/gitignore/listTemplates.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
name: Listing available templates
name: Get all gitignore templates
example: octokit.gitignore.listTemplates()
route: GET /gitignore/templates
scope: gitignore
type: API method
---

# Listing available templates
# Get all gitignore templates

**Deprecated:** This method has been renamed to gitignore.getAllTemplates

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).

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

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#listing-available-templates).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/gitignore/#get-all-gitignore-templates).
6 changes: 3 additions & 3 deletions docs/licenses/get.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Get an individual license
name: Get a license
example: octokit.licenses.get({ license })
route: GET /licenses/{license}
scope: licenses
type: API method
---

# Get an individual license
# Get a license

```js
octokit.licenses.get({
Expand All @@ -31,4 +31,4 @@ octokit.licenses.get({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-an-individual-license).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-a-license).
19 changes: 19 additions & 0 deletions docs/licenses/getAllCommonlyUsed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Get all commonly used licenses
example: octokit.licenses.getAllCommonlyUsed()
route: GET /licenses
scope: licenses
type: API method
---

# Get all commonly used licenses

```js
octokit.licenses.getAllCommonlyUsed();
```

## Parameters

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-all-commonly-used-licenses).
6 changes: 3 additions & 3 deletions docs/licenses/getForRepo.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Get the contents of a repository's license
name: Get the license for a repository
example: octokit.licenses.getForRepo({ owner, repo })
route: GET /repos/{owner}/{repo}/license
scope: licenses
type: API method
---

# Get the contents of a repository's license
# Get the license for a repository

This method returns the contents of the repository's license file, if one is detected.

Expand Down Expand Up @@ -39,4 +39,4 @@ octokit.licenses.getForRepo({
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-the-license-for-a-repository).
8 changes: 5 additions & 3 deletions docs/licenses/listCommonlyUsed.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
name: List commonly used licenses
name: Get all commonly used licenses
example: octokit.licenses.listCommonlyUsed()
route: GET /licenses
scope: licenses
type: API method
---

# List commonly used licenses
# Get all commonly used licenses

**Deprecated:** This method has been renamed to licenses.getAllCommonlyUsed

```js
octokit.licenses.listCommonlyUsed();
Expand All @@ -16,4 +18,4 @@ octokit.licenses.listCommonlyUsed();

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#list-commonly-used-licenses).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/licenses/#get-all-commonly-used-licenses).
6 changes: 3 additions & 3 deletions docs/markdown/render.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Render an arbitrary Markdown document
name: Render a Markdown document
example: octokit.markdown.render({ text })
route: POST /markdown
scope: markdown
type: API method
---

# Render an arbitrary Markdown document
# Render a Markdown document

```js
octokit.markdown.render({
Expand Down Expand Up @@ -45,4 +45,4 @@ The repository context to use when creating references in `gfm` mode. Omit this
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/markdown/#render-a-markdown-document).
6 changes: 3 additions & 3 deletions docs/meta/get.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Get
name: Get GitHub meta information
example: octokit.meta.get()
route: GET /meta
scope: meta
type: API method
---

# Get
# Get GitHub meta information

This endpoint provides a list of GitHub's IP addresses. For more information, see "[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/)."

Expand All @@ -18,4 +18,4 @@ octokit.meta.get();

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/meta/#meta).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/meta/#get-github-meta-information).
6 changes: 3 additions & 3 deletions docs/rateLimit/get.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
name: Get your current rate limit status
name: Get rate limit status for the authenticated user
example: octokit.rateLimit.get()
route: GET /rate_limit
scope: rateLimit
type: API method
---

# Get your current rate limit status
# Get rate limit status for the authenticated user

**Note:** Accessing this endpoint does not count against your REST API rate limit.

Expand Down Expand Up @@ -35,4 +35,4 @@ octokit.rateLimit.get();

This endpoint has no parameters

See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status).
See also: [GitHub Developer Guide documentation](https://developer.github.com/v3/rate_limit/#get-rate-limit-status-for-the-authenticated-user).
Loading