summaryrefslogtreecommitdiffstats
path: root/descriptions/api.github.com/api.github.com.2022-11-28.yaml
diff options
context:
space:
mode:
authorgithub-openapi-bot <security+github-openapi-bot@github.com>2025-03-19 16:34:10 -0700
committergithub-openapi-bot <security+github-openapi-bot@github.com>2025-03-19 16:34:10 -0700
commitde1d0b794f3f089a0b2df72b6490279171143970 (patch)
treed24cde76577093d6d055c271df6a643bd11ad3ca /descriptions/api.github.com/api.github.com.2022-11-28.yaml
parentfd8b14666d8a4e34411bee8dbd103edc8b81d0e3 (diff)
downloadrest-api-description-de1d0b794f3f089a0b2df72b6490279171143970.tar.gz
rest-api-description-de1d0b794f3f089a0b2df72b6490279171143970.zip
Update OpenAPI 3.0 Descriptions
Diffstat (limited to 'descriptions/api.github.com/api.github.com.2022-11-28.yaml')
-rw-r--r--descriptions/api.github.com/api.github.com.2022-11-28.yaml33
1 files changed, 24 insertions, 9 deletions
diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
index 4536c8228..485f791fb 100644
--- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml
+++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml
@@ -11605,7 +11605,8 @@ paths:
"/orgs/{org}/issue-types":
get:
summary: List issue types for an organization
- description: Lists all issue types for an organization.
+ description: Lists all issue types for an organization. OAuth app tokens and
+ personal access tokens (classic) need the read:org scope to use this endpoint.
tags:
- orgs
operationId: orgs/list-issue-types
@@ -11639,6 +11640,9 @@ paths:
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).
+
+ To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
+ personal access tokens (classic) need the `admin:org` scope to use this endpoint.
tags:
- orgs
operationId: orgs/create-issue-type
@@ -11686,6 +11690,9 @@ paths:
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).
+
+ To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
+ personal access tokens (classic) need the `admin:org` scope to use this endpoint.
tags:
- orgs
operationId: orgs/update-issue-type
@@ -11733,6 +11740,9 @@ paths:
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).
+
+ To use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and
+ personal access tokens (classic) need the `admin:org` scope to use this endpoint.
tags:
- orgs
operationId: orgs/delete-issue-type
@@ -34200,7 +34210,9 @@ paths:
type: string
type:
type: string
- description: The name of the issue type to associate with this issue.
+ description: 'The name of the issue type to associate with this
+ issue. _NOTE: Only users with push access can set the type for
+ new issues. The type is silently dropped otherwise._'
nullable: true
example: Epic
required:
@@ -34802,7 +34814,9 @@ paths:
type:
type: string
description: The name of the issue type to associate with this issue
- or use `null` to remove the current issue type.
+ or use `null` to remove the current issue type. Only users with
+ push access can set the type for issues. Without push access to
+ the repository, type changes are silently dropped.
nullable: true
example: Epic
examples:
@@ -79735,8 +79749,9 @@ components:
- pattern
repository-rule-file-path-restriction:
title: file_path_restriction
- description: Prevent commits that include changes in specified file paths from
- being pushed to the commit graph.
+ description: Prevent commits that include changes in specified file and folder
+ paths from being pushed to the commit graph. This includes absolute paths
+ that contain file names.
type: object
required:
- type
@@ -79758,7 +79773,7 @@ components:
- restricted_file_paths
repository-rule-max-file-path-length:
title: max_file_path_length
- description: Prevent commits that include file paths that exceed a specified
+ description: Prevent commits that include file paths that exceed the specified
character limit from being pushed to the commit graph.
type: object
required:
@@ -79773,7 +79788,7 @@ components:
properties:
max_file_path_length:
type: integer
- description: The maximum amount of characters allowed in file paths
+ description: The maximum amount of characters allowed in file paths.
minimum: 1
maximum: 256
required:
@@ -79803,8 +79818,8 @@ components:
- restricted_file_extensions
repository-rule-max-file-size:
title: max_file_size
- description: Prevent commits that exceed a specified file size limit from being
- pushed to the commit graph.
+ description: Prevent commits with individual files that exceed the specified
+ limit from being pushed to the commit graph.
type: object
required:
- type