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
2 changes: 1 addition & 1 deletion docs/apps/createInstallationAccessToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ The level of permission to grant the access token for repository contents, commi
</td></tr>
<tr><td>permissions.dependabot_secrets</td><td>no</td><td>

The leve of permission to grant the access token to manage Dependabot secrets.
The level of permission to grant the access token to manage Dependabot secrets.

</td></tr>
<tr><td>permissions.deployments</td><td>no</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/apps/scopeToken.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The level of permission to grant the access token for repository contents, commi
</td></tr>
<tr><td>permissions.dependabot_secrets</td><td>no</td><td>

The leve of permission to grant the access token to manage Dependabot secrets.
The level of permission to grant the access token to manage Dependabot secrets.

</td></tr>
<tr><td>permissions.deployments</td><td>no</td><td>
Expand Down
2 changes: 1 addition & 1 deletion docs/codespaces/createOrUpdateRepoSecret.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ type: API method
Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)."

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.

```js
octokit.rest.codespaces.createOrUpdateRepoSecret({
Expand Down
2 changes: 1 addition & 1 deletion docs/codespaces/deleteRepoSecret.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type: API method

Deletes a development environment secret in a repository using the secret name.

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The associated user must be a repository admin.

```js
octokit.rest.codespaces.deleteRepoSecret({
Expand Down
5 changes: 5 additions & 0 deletions docs/issues/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ Labels to associate with this issue. _NOTE: Only users with push access can set

Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._

</td></tr>
<tr><td>type</td><td>no</td><td>

The name of the issue type to associate with this issue.

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/issues/listForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,11 @@ Indicates the state of the issues to return.

A list of comma separated label names. Example: `bug,ui,@high`

</td></tr>
<tr><td>type</td><td>no</td><td>

Can be the name of an issue type.

</td></tr>
<tr><td>sort</td><td>no</td><td>

Expand Down
5 changes: 5 additions & 0 deletions docs/issues/listForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ Indicates the state of the issues to return.

Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.

</td></tr>
<tr><td>type</td><td>no</td><td>

Can be the name of an issue type. If the string `*` is passed, issues with any type are accepted. If the string `none` is passed, issues without type are returned.

</td></tr>
<tr><td>creator</td><td>no</td><td>

Expand Down
5 changes: 5 additions & 0 deletions docs/issues/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ Labels to associate with this issue. Pass one or more labels to _replace_ the se

Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.

</td></tr>
<tr><td>type</td><td>no</td><td>

The name of the issue type to associate with this issue or use `null` to remove the current issue type.

</td></tr>
</tbody>
</table>
Expand Down
67 changes: 67 additions & 0 deletions docs/orgs/createIssueType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
name: Create issue type for an organization
example: octokit.rest.orgs.createIssueType({ org, name, is_enabled })
route: POST /orgs/{org}/issue-types
scope: orgs
type: API method
---

# Create issue type for an organization

Create a new issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

```js
octokit.rest.orgs.createIssueType({
org,
name,
is_enabled,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
<tr><td>name</td><td>yes</td><td>

Name of the issue type.

</td></tr>
<tr><td>is_enabled</td><td>yes</td><td>

Whether or not the issue type is enabled at the organization level.

</td></tr>
<tr><td>is_private</td><td>no</td><td>

Whether or not the issue type is restricted to issues in private repositories.

</td></tr>
<tr><td>description</td><td>no</td><td>

Description of the issue type.

</td></tr>
<tr><td>color</td><td>no</td><td>

Color for the issue type.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/issue-types#create-issue-type-for-an-organization).
4 changes: 4 additions & 0 deletions docs/orgs/createOrUpdateCustomProperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ type: API method

Creates new or updates existing custom properties defined for an organization in a batch.

If the property already exists, the existing property will be replaced with the new values.
Missing optional values will fall back to default values, previous values will be overwritten.
E.g. if a property exists with `values_editable_by: org_and_repo_actors` and it's updated without specifying `values_editable_by`, it will be updated to default value `org_actors`.

To use this endpoint, the authenticated user must be one of:

- An administrator for the organization.
Expand Down
5 changes: 5 additions & 0 deletions docs/orgs/createOrUpdateCustomProperty.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ Short description of the property
An ordered list of the allowed values of the property.
The property can have up to 200 allowed values.

</td></tr>
<tr><td>values_editable_by</td><td>no</td><td>

Who can edit the values of the property

</td></tr>
</tbody>
</table>
Expand Down
46 changes: 46 additions & 0 deletions docs/orgs/deleteIssueType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Delete issue type for an organization
example: octokit.rest.orgs.deleteIssueType({ org, issue_type_id })
route: DELETE /orgs/{org}/issue-types/{issue_type_id}
scope: orgs
type: API method
---

# Delete issue type for an organization

Deletes an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

```js
octokit.rest.orgs.deleteIssueType({
org,
issue_type_id,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
<tr><td>issue_type_id</td><td>yes</td><td>

The unique identifier of the issue type.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/issue-types#delete-issue-type-for-an-organization).
38 changes: 38 additions & 0 deletions docs/orgs/listIssueTypes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: List issue types for an organization
example: octokit.rest.orgs.listIssueTypes({ org })
route: GET /orgs/{org}/issue-types
scope: orgs
type: API method
---

# List issue types for an organization

Lists all issue types for an organization.

```js
octokit.rest.orgs.listIssueTypes({
org,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/issue-types#list-issue-types-for-an-organization).
5 changes: 5 additions & 0 deletions docs/orgs/listPatGrantRequests.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ Only show fine-grained personal access tokens used before the given time. This i

Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.

</td></tr>
<tr><td>token_id</td><td>no</td><td>

The ID of the token

</td></tr>
</tbody>
</table>
Expand Down
5 changes: 5 additions & 0 deletions docs/orgs/listPatGrants.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,11 @@ Only show fine-grained personal access tokens used before the given time. This i

Only show fine-grained personal access tokens used after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.

</td></tr>
<tr><td>token_id</td><td>no</td><td>

The ID of the token

</td></tr>
</tbody>
</table>
Expand Down
73 changes: 73 additions & 0 deletions docs/orgs/updateIssueType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
name: Update issue type for an organization
example: octokit.rest.orgs.updateIssueType({ org, issue_type_id, name, is_enabled })
route: PUT /orgs/{org}/issue-types/{issue_type_id}
scope: orgs
type: API method
---

# Update issue type for an organization

Updates an issue type for an organization.

You can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).

```js
octokit.rest.orgs.updateIssueType({
org,
issue_type_id,
name,
is_enabled,
});
```

## Parameters

<table>
<thead>
<tr>
<th>name</th>
<th>required</th>
<th>description</th>
</tr>
</thead>
<tbody>
<tr><td>org</td><td>yes</td><td>

The organization name. The name is not case sensitive.

</td></tr>
<tr><td>issue_type_id</td><td>yes</td><td>

The unique identifier of the issue type.

</td></tr>
<tr><td>name</td><td>yes</td><td>

Name of the issue type.

</td></tr>
<tr><td>is_enabled</td><td>yes</td><td>

Whether or not the issue type is enabled at the organization level.

</td></tr>
<tr><td>is_private</td><td>no</td><td>

Whether or not the issue type is restricted to issues in private repositories.

</td></tr>
<tr><td>description</td><td>no</td><td>

Description of the issue type.

</td></tr>
<tr><td>color</td><td>no</td><td>

Color for the issue type.

</td></tr>
</tbody>
</table>

See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/orgs/issue-types#update-issue-type-for-an-organization).
2 changes: 1 addition & 1 deletion docs/repos/createDeploymentProtectionRule.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Enable a custom deployment protection rule for an environment.

The authenticated user must have admin or owner permissions to the repository to use this endpoint.

For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app).
For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app), as well as the [guide to creating custom deployment protection rules](https://docs.github.com/actions/managing-workflow-runs-and-deployments/managing-deployments/creating-custom-deployment-protection-rules).

OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.

Expand Down
1 change: 1 addition & 0 deletions docs/search/issuesAndPullRequests.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ type: API method
**This method is deprecated.**

> [!WARNING] > **Notice:** Search for issues and pull requests will be overridden by advanced search on September 4, 2025.
> You can read more about this change on [the GitHub blog](https://github.blog/changelog/2025-03-06-github-issues-projects-api-support-for-issues-advanced-search-and-more/).

```js
octokit.rest.search.issuesAndPullRequests({
Expand Down
Loading
Loading