diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 954d31db02..344352468f 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -15967,7 +15967,7 @@ "/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" ], @@ -16013,7 +16013,7 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou 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).", + "description": "Create a new issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -16081,7 +16081,7 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou 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).", + "description": "Updates an issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -16150,7 +16150,7 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou 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).", + "description": "Deletes an issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -46695,7 +46695,7 @@ }, "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" } @@ -47545,7 +47545,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } 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 4536c82281..7d8a066222 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: diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 954d31db02..344352468f 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -15967,7 +15967,7 @@ "/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" ], @@ -16013,7 +16013,7 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou 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).", + "description": "Create a new issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -16081,7 +16081,7 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou 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).", + "description": "Updates an issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -16150,7 +16150,7 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou 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).", + "description": "Deletes an issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -46695,7 +46695,7 @@ }, "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" } @@ -47545,7 +47545,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 4536c82281..7d8a066222 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.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: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index a16d125b8b..bb61dc05ac 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -92188,7 +92188,7 @@ "/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" ], @@ -92337,7 +92337,7 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou 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).", + "description": "Create a new issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -92563,7 +92563,7 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou 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).", + "description": "Updates an issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -92796,7 +92796,7 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou 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).", + "description": "Deletes an issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -293156,7 +293156,7 @@ }, "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" } @@ -309096,7 +309096,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } diff --git a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 21d310d1dd..e6a3f837b7 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -27307,7 +27307,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 @@ -27351,6 +27352,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 @@ -27433,6 +27437,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 @@ -27514,6 +27521,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 @@ -69994,7 +70004,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: @@ -71280,7 +71292,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: diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index a16d125b8b..bb61dc05ac 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -92188,7 +92188,7 @@ "/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" ], @@ -92337,7 +92337,7 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou 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).", + "description": "Create a new issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -92563,7 +92563,7 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou 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).", + "description": "Updates an issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -92796,7 +92796,7 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou 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).", + "description": "Deletes an issue type for an organization.\n\nYou 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).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -293156,7 +293156,7 @@ }, "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" } @@ -309096,7 +309096,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 21d310d1dd..e6a3f837b7 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -27307,7 +27307,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 @@ -27351,6 +27352,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 @@ -27433,6 +27437,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 @@ -27514,6 +27521,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 @@ -69994,7 +70004,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: @@ -71280,7 +71292,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: diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index b217da9f9d..cd5b95b4c2 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -123296,7 +123296,7 @@ "/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" ], @@ -123445,7 +123445,7 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -123671,7 +123671,7 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -123904,7 +123904,7 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -328955,7 +328955,7 @@ }, "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" } @@ -344895,7 +344895,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } @@ -598394,7 +598394,7 @@ }, "bypass-request-push-ruleset-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was cancelled.", "operationId": "exemption-request-push-ruleset/cancelled", "externalDocs": { @@ -600338,7 +600338,7 @@ }, "bypass-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was completed.", "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { @@ -602282,7 +602282,7 @@ }, "bypass-request-push-ruleset-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was created.", "operationId": "exemption-request-push-ruleset/created", "externalDocs": { @@ -604226,7 +604226,7 @@ }, "bypass-request-push-ruleset-response-dismissed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass response was dismissed.", "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { @@ -606209,7 +606209,7 @@ }, "bypass-request-push-ruleset-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 7f42c6a9a4..d59004ded3 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -35938,7 +35938,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 @@ -35982,6 +35983,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/enterprise-cloud@latest//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 @@ -36064,6 +36068,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/enterprise-cloud@latest//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 @@ -36145,6 +36152,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/enterprise-cloud@latest//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 @@ -78244,7 +78254,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: @@ -79530,7 +79542,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: @@ -111459,8 +111473,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was cancelled. operationId: exemption-request-push-ruleset/cancelled externalDocs: @@ -111806,8 +111818,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was completed. operationId: exemption-request-push-ruleset/completed externalDocs: @@ -111890,8 +111900,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was created. operationId: exemption-request-push-ruleset/created externalDocs: @@ -111974,8 +111982,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass response was dismissed. operationId: exemption-request-push-ruleset/response-dismissed externalDocs: @@ -112060,8 +112066,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A response either approving or rejecting the push ruleset bypass request was submitted. operationId: exemption-request-push-ruleset/response-submitted diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index b217da9f9d..cd5b95b4c2 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -123296,7 +123296,7 @@ "/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" ], @@ -123445,7 +123445,7 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -123671,7 +123671,7 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -123904,7 +123904,7 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -328955,7 +328955,7 @@ }, "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" } @@ -344895,7 +344895,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } @@ -598394,7 +598394,7 @@ }, "bypass-request-push-ruleset-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was cancelled.", "operationId": "exemption-request-push-ruleset/cancelled", "externalDocs": { @@ -600338,7 +600338,7 @@ }, "bypass-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was completed.", "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { @@ -602282,7 +602282,7 @@ }, "bypass-request-push-ruleset-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was created.", "operationId": "exemption-request-push-ruleset/created", "externalDocs": { @@ -604226,7 +604226,7 @@ }, "bypass-request-push-ruleset-response-dismissed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass response was dismissed.", "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { @@ -606209,7 +606209,7 @@ }, "bypass-request-push-ruleset-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { diff --git a/descriptions/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 7f42c6a9a4..d59004ded3 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -35938,7 +35938,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 @@ -35982,6 +35983,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/enterprise-cloud@latest//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 @@ -36064,6 +36068,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/enterprise-cloud@latest//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 @@ -36145,6 +36152,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/enterprise-cloud@latest//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 @@ -78244,7 +78254,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: @@ -79530,7 +79542,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: @@ -111459,8 +111473,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was cancelled. operationId: exemption-request-push-ruleset/cancelled externalDocs: @@ -111806,8 +111818,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was completed. operationId: exemption-request-push-ruleset/completed externalDocs: @@ -111890,8 +111900,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was created. operationId: exemption-request-push-ruleset/created externalDocs: @@ -111974,8 +111982,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass response was dismissed. operationId: exemption-request-push-ruleset/response-dismissed externalDocs: @@ -112060,8 +112066,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A response either approving or rejecting the push ruleset bypass request was submitted. operationId: exemption-request-push-ruleset/response-submitted diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 04d4a14fd5..96fdd497b1 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -22960,7 +22960,7 @@ "/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" ], @@ -23006,7 +23006,7 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -23074,7 +23074,7 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -23143,7 +23143,7 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -54856,7 +54856,7 @@ }, "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" } @@ -55706,7 +55706,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } @@ -81144,7 +81144,7 @@ }, "bypass-request-push-ruleset-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was cancelled.", "operationId": "exemption-request-push-ruleset/cancelled", "externalDocs": { @@ -81237,7 +81237,7 @@ }, "bypass-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was completed.", "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { @@ -81330,7 +81330,7 @@ }, "bypass-request-push-ruleset-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was created.", "operationId": "exemption-request-push-ruleset/created", "externalDocs": { @@ -81423,7 +81423,7 @@ }, "bypass-request-push-ruleset-response-dismissed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass response was dismissed.", "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { @@ -81516,7 +81516,7 @@ }, "bypass-request-push-ruleset-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 02dc0656a9..d0ac2c7058 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -16620,7 +16620,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 @@ -16654,6 +16655,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/enterprise-cloud@latest//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 @@ -16701,6 +16705,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/enterprise-cloud@latest//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 @@ -16748,6 +16755,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/enterprise-cloud@latest//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 @@ -40084,7 +40094,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: @@ -40686,7 +40698,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: @@ -58833,8 +58847,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was cancelled. operationId: exemption-request-push-ruleset/cancelled externalDocs: @@ -58901,8 +58913,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was completed. operationId: exemption-request-push-ruleset/completed externalDocs: @@ -58969,8 +58979,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was created. operationId: exemption-request-push-ruleset/created externalDocs: @@ -59037,8 +59045,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass response was dismissed. operationId: exemption-request-push-ruleset/response-dismissed externalDocs: @@ -59105,8 +59111,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A response either approving or rejecting the push ruleset bypass request was submitted. operationId: exemption-request-push-ruleset/response-submitted diff --git a/descriptions/ghec/ghec.json b/descriptions/ghec/ghec.json index 04d4a14fd5..96fdd497b1 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -22960,7 +22960,7 @@ "/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" ], @@ -23006,7 +23006,7 @@ }, "post": { "summary": "Create issue type for an organization", - "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Create a new issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -23074,7 +23074,7 @@ "/orgs/{org}/issue-types/{issue_type_id}": { "put": { "summary": "Update issue type for an organization", - "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Updates an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -23143,7 +23143,7 @@ }, "delete": { "summary": "Delete issue type for an organization", - "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).", + "description": "Deletes an issue type for an organization.\n\nYou can find out more about issue types in [Managing issue types in an organization](https://docs.github.com/enterprise-cloud@latest//issues/tracking-your-work-with-issues/configuring-issues/managing-issue-types-in-an-organization).\n\nTo use this endpoint, the authenticated user must be an administrator for the organization. OAuth app tokens and\npersonal access tokens (classic) need the `admin:org` scope to use this endpoint.", "tags": [ "orgs" ], @@ -54856,7 +54856,7 @@ }, "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" } @@ -55706,7 +55706,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } @@ -81144,7 +81144,7 @@ }, "bypass-request-push-ruleset-cancelled": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was cancelled.", "operationId": "exemption-request-push-ruleset/cancelled", "externalDocs": { @@ -81237,7 +81237,7 @@ }, "bypass-request-push-ruleset-completed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was completed.", "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { @@ -81330,7 +81330,7 @@ }, "bypass-request-push-ruleset-created": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was created.", "operationId": "exemption-request-push-ruleset/created", "externalDocs": { @@ -81423,7 +81423,7 @@ }, "bypass-request-push-ruleset-response-dismissed": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass response was dismissed.", "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { @@ -81516,7 +81516,7 @@ }, "bypass-request-push-ruleset-response-submitted": { "post": { - "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.\n\nNote: Delegated bypass for push rules is currently in public preview and subject to change.", + "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { diff --git a/descriptions/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index 02dc0656a9..d0ac2c7058 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -16620,7 +16620,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 @@ -16654,6 +16655,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/enterprise-cloud@latest//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 @@ -16701,6 +16705,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/enterprise-cloud@latest//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 @@ -16748,6 +16755,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/enterprise-cloud@latest//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 @@ -40084,7 +40094,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: @@ -40686,7 +40698,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: @@ -58833,8 +58847,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was cancelled. operationId: exemption-request-push-ruleset/cancelled externalDocs: @@ -58901,8 +58913,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was completed. operationId: exemption-request-push-ruleset/completed externalDocs: @@ -58969,8 +58979,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass request was created. operationId: exemption-request-push-ruleset/created externalDocs: @@ -59037,8 +59045,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A push ruleset bypass response was dismissed. operationId: exemption-request-push-ruleset/response-dismissed externalDocs: @@ -59105,8 +59111,6 @@ x-webhooks: For more information, see "[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest//repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules)." To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - - Note: Delegated bypass for push rules is currently in public preview and subject to change. description: A response either approving or rejecting the push ruleset bypass request was submitted. operationId: exemption-request-push-ruleset/response-submitted diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json index 90d3870af9..2fdeae3c81 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.json @@ -263691,7 +263691,7 @@ }, "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" } @@ -279595,7 +279595,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml index 3d8780799f..a62612ff45 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.2022-11-28.deref.yaml @@ -62389,7 +62389,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: @@ -63685,7 +63687,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: diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json index 90d3870af9..2fdeae3c81 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.json @@ -263691,7 +263691,7 @@ }, "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" } @@ -279595,7 +279595,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } diff --git a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml index 3d8780799f..a62612ff45 100644 --- a/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml +++ b/descriptions/ghes-3.12/dereferenced/ghes-3.12.deref.yaml @@ -62389,7 +62389,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: @@ -63685,7 +63687,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: diff --git a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json index ec19ab9838..77d07bd12d 100644 --- a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json +++ b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.json @@ -42990,7 +42990,7 @@ }, "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" } @@ -43840,7 +43840,7 @@ }, "type": { "type": "string", - "description": "The name of the issue type to associate with this issue or use `null` to remove the current issue type.", + "description": "The name of the issue type to associate with this issue 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" } diff --git a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml index 65b4635439..ac2f2c9e1b 100644 --- a/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml +++ b/descriptions/ghes-3.12/ghes-3.12.2022-11-28.yaml @@ -31200,7 +31200,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: @@ -31802,7 +31804,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 {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}