From 612a9cc1ec90414e12b1dd670a6e199cae0ea7aa Mon Sep 17 00:00:00 2001 From: Octokit Bot Date: Wed, 7 Sep 2022 05:45:50 -0700 Subject: [PATCH] feat: add new public beta APIs for creating, reading, updating and deleting custom repo roles and return additional attributes on custom repo roles in existing APIs (#241) WIP --- cache/api.github.com.json | 532 +++++++++++++++++- cache/ghes-3.2.json | 16 +- cache/ghes-3.3.json | 16 +- cache/ghes-3.4.json | 20 +- cache/ghes-3.5.json | 20 +- cache/ghes-3.6.json | 136 ++++- cache/github.ae.json | 114 +++- packages/openapi-types-ghes-3.2/package.json | 2 +- packages/openapi-types-ghes-3.2/types.d.ts | 8 +- packages/openapi-types-ghes-3.3/package.json | 2 +- packages/openapi-types-ghes-3.3/types.d.ts | 8 +- packages/openapi-types-ghes-3.4/package.json | 2 +- packages/openapi-types-ghes-3.4/types.d.ts | 8 +- packages/openapi-types-ghes-3.5/package.json | 2 +- packages/openapi-types-ghes-3.5/types.d.ts | 8 +- packages/openapi-types-ghes-3.6/package.json | 2 +- packages/openapi-types-ghes-3.6/types.d.ts | 56 +- packages/openapi-types-github.ae/package.json | 2 +- packages/openapi-types-github.ae/types.d.ts | 50 +- packages/openapi-types/package.json | 2 +- packages/openapi-types/types.d.ts | 240 +++++++- 21 files changed, 1119 insertions(+), 127 deletions(-) diff --git a/cache/api.github.com.json b/cache/api.github.com.json index 84ba5d6bd..251e26650 100644 --- a/cache/api.github.com.json +++ b/cache/api.github.com.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.9.1", + "version": "7.10.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -6969,7 +6969,7 @@ }, "examples": { "default": { - "$ref": "#/components/examples/organization-custom-repository-role-example-old" + "$ref": "#/components/examples/organization-custom-repository-role-example" } } } @@ -10292,6 +10292,305 @@ "x-octokit": {} } }, + "/orgs/{org}/custom_roles": { + "post": { + "summary": "Create a custom role", + "description": "**Note**: This operation is in beta and is subject to change.\n\nCreates a custom repository role that can be used by all repositories owned by the organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#create-a-custom-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the custom role." + }, + "description": { + "type": "string", + "description": "A short description about the intended usage of this role or what permissions it grants." + }, + "base_role": { + "type": "string", + "enum": [ + "read", + "triage", + "write", + "maintain" + ], + "description": "The system role from which this role inherits permissions." + }, + "permissions": { + "type": "array", + "description": "A list of additional permissions included in this role.", + "items": { + "type": "string" + } + } + }, + "required": [ + "name", + "base_role", + "permissions" + ] + }, + "examples": { + "default": { + "value": { + "name": "Labeler", + "description": "A role for issue and PR labelers", + "base_role": "read", + "permissions": [ + "add_label" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-repository-role" + }, + "examples": { + "default": { + "value": { + "id": 8030, + "name": "Labeler", + "description": "A role for issue and PR labelers", + "base_role": "read", + "permissions": [ + "add_label" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:19:11Z" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-roles" + }, + "x-octokit": {} + } + }, + "/orgs/{org}/custom_roles/{role_id}": { + "patch": { + "summary": "Update a custom role", + "description": "**Note**: This operation is in beta and subject to change.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#update-a-custom-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the custom role." + }, + "description": { + "type": "string", + "description": "A short description about who this role is for or what permissions it grants." + }, + "base_role": { + "type": "string", + "enum": [ + "read", + "triage", + "write", + "maintain" + ], + "description": "The system role from which this role inherits permissions." + }, + "permissions": { + "type": "array", + "description": "A list of additional permissions included in this role. If specified, these permissions will replace any currently set on the role.", + "items": { + "type": "string" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "Labeler", + "description": "A role for issue and PR labelers", + "base_role": "read", + "permissions": [ + "add_label", + "remove_label" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/organization-custom-repository-role" + }, + "examples": { + "default": { + "value": { + "id": 8030, + "name": "Labeler", + "description": "A role for issue and PR labelers", + "base_role": "read", + "permissions": [ + "add_label", + "remove_label" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:19:11Z" + } + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "$ref": "#/components/responses/validation_failed" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "custom-roles" + }, + "x-octokit": {} + }, + "delete": { + "summary": "Delete a custom role", + "description": "**Note**: This operation is in beta and is subject to change.\n\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/role-id" + } + ], + "responses": { + "204": { + "description": "Response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "custom-roles" + }, + "x-octokit": {} + } + }, "/orgs/{org}/dependabot/secrets": { "get": { "summary": "List organization secrets", @@ -11035,6 +11334,53 @@ "x-octokit": {} } }, + "/orgs/{org}/fine_grained_permissions": { + "get": { + "summary": "List fine-grained permissions for an organization", + "description": "**Note**: This operation is in beta and subject to change.\n\nLists the fine-grained permissions available for an organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-fine-grained-permissions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "$ref": "#/components/schemas/organization-fine-grained-permission" + } + }, + "examples": { + "default": { + "$ref": "#/components/examples/organization-fine-grained-permission-example" + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "custom-roles" + }, + "x-octokit": {} + } + }, "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", @@ -13708,15 +14054,15 @@ }, "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by an organization", - "description": "Returns all package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "summary": "List package versions for a package owned by an organization", + "description": "Lists package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization" }, "parameters": [ { @@ -14484,8 +14830,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -19395,8 +19742,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -22915,7 +23263,7 @@ }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { - "summary": "List workflow runs", + "summary": "List workflow runs for a workflow", "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" @@ -31012,7 +31360,7 @@ }, "sha": { "type": "string", - "description": "The blob SHA of the file being replaced." + "description": "The blob SHA of the file being deleted." }, "branch": { "type": "string", @@ -56051,15 +56399,15 @@ }, "/user/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by the authenticated user", - "description": "Returns all package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "summary": "List package versions for a package owned by the authenticated user", + "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" }, "parameters": [ { @@ -58547,15 +58895,15 @@ }, "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by a user", - "description": "Returns all package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", + "summary": "List package versions for a package owned by a user", + "description": "Lists package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.", "tags": [ "packages" ], "operationId": "packages/get-all-package-versions-for-package-owned-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user" }, "parameters": [ { @@ -61660,8 +62008,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default.", - "default": false + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -66618,8 +66967,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default.", - "default": false + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -67323,6 +67673,39 @@ "name": { "description": "The name of the custom role.", "type": "string" + }, + "description": { + "description": "A short description about who this role is for or what permissions it grants.", + "type": "string", + "nullable": true + }, + "base_role": { + "type": "string", + "description": "The system role from which this role inherits permissions.", + "enum": [ + "read", + "triage", + "write", + "maintain" + ] + }, + "permissions": { + "description": "A list of additional permissions included in this role.", + "type": "array", + "items": { + "type": "string" + } + }, + "organization": { + "$ref": "#/components/schemas/simple-user" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } }, "required": [ @@ -68506,6 +68889,23 @@ "node_id" ] }, + "organization-fine-grained-permission": { + "title": "Organization Fine-Grained Permission", + "description": "Fine-grained permissions available for the organization", + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "description": { + "type": "string" + } + }, + "required": [ + "name", + "description" + ] + }, "org-hook": { "title": "Org Hook", "description": "Org Hook", @@ -91963,17 +92363,76 @@ } ] }, - "organization-custom-repository-role-example-old": { + "organization-custom-repository-role-example": { "value": { "total_count": 2, "custom_roles": [ { "id": 8030, - "name": "Developer" + "name": "Security Engineer", + "description": "Able to contribute code and maintain the security pipeline", + "base_role": "maintain", + "permissions": [ + "delete_alerts_code_scanning" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-04T22:19:11Z", + "updated_at": "2022-07-04T22:20:11Z" }, { "id": 8031, - "name": "Designer" + "name": "Community manager", + "description": "Able to handle all the community interactions without being able to contribute code", + "base_role": "read", + "permissions": [ + "mark_as_duplicate", + "manage_settings_pages", + "manage_settings_wiki", + "set_social_preview", + "edit_repo_metadata", + "toggle_discussion_comment_minimize" + ], + "organization": { + "login": "github", + "id": 9919, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", + "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false + }, + "created_at": "2022-07-05T12:01:11Z", + "updated_at": "2022-07-05T12:20:11Z" } ] } @@ -93375,6 +93834,22 @@ } ] }, + "organization-fine-grained-permission-example": { + "value": [ + { + "name": "add_assignee", + "description": "Assign or remove a user" + }, + { + "name": "remove_assignee", + "description": "Remove an assigned user" + }, + { + "name": "add_label", + "description": "Add or remove a label" + } + ] + }, "org-hook-items": { "value": [ { @@ -112948,6 +113423,15 @@ "type": "string" } }, + "role-id": { + "name": "role_id", + "description": "The unique identifier of the role.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, "group-id": { "name": "group_id", "description": "The unique identifier of the group.", diff --git a/cache/ghes-3.2.json b/cache/ghes-3.2.json index f3d8f9500..3aaf7f301 100644 --- a/cache/ghes-3.2.json +++ b/cache/ghes-3.2.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.9.1", + "version": "7.10.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -13884,8 +13884,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -18298,8 +18299,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -20633,7 +20635,7 @@ }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { - "summary": "List workflow runs", + "summary": "List workflow runs for a workflow", "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" @@ -27623,7 +27625,7 @@ }, "sha": { "type": "string", - "description": "The blob SHA of the file being replaced." + "description": "The blob SHA of the file being deleted." }, "branch": { "type": "string", diff --git a/cache/ghes-3.3.json b/cache/ghes-3.3.json index e62bf2ff7..edd2d6015 100644 --- a/cache/ghes-3.3.json +++ b/cache/ghes-3.3.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.9.1", + "version": "7.10.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -13799,8 +13799,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -18013,8 +18014,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -20295,7 +20297,7 @@ }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { - "summary": "List workflow runs", + "summary": "List workflow runs for a workflow", "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" @@ -27496,7 +27498,7 @@ }, "sha": { "type": "string", - "description": "The blob SHA of the file being replaced." + "description": "The blob SHA of the file being deleted." }, "branch": { "type": "string", diff --git a/cache/ghes-3.4.json b/cache/ghes-3.4.json index 29ca0e443..7c44ced93 100644 --- a/cache/ghes-3.4.json +++ b/cache/ghes-3.4.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.9.1", + "version": "7.10.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -9445,7 +9445,7 @@ }, "examples": { "default": { - "$ref": "#/components/examples/organization-custom-repository-role-example-old" + "$ref": "#/components/examples/organization-custom-repository-role-example" } } } @@ -15079,8 +15079,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -19351,8 +19352,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -21919,7 +21921,7 @@ }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { - "summary": "List workflow runs", + "summary": "List workflow runs for a workflow", "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" @@ -29056,7 +29058,7 @@ }, "sha": { "type": "string", - "description": "The blob SHA of the file being replaced." + "description": "The blob SHA of the file being deleted." }, "branch": { "type": "string", @@ -81501,7 +81503,7 @@ } ] }, - "organization-custom-repository-role-example-old": { + "organization-custom-repository-role-example": { "value": { "total_count": 2, "custom_roles": [ diff --git a/cache/ghes-3.5.json b/cache/ghes-3.5.json index 7fe685148..552ff1f71 100644 --- a/cache/ghes-3.5.json +++ b/cache/ghes-3.5.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.9.1", + "version": "7.10.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -9637,7 +9637,7 @@ }, "examples": { "default": { - "$ref": "#/components/examples/organization-custom-repository-role-example-old" + "$ref": "#/components/examples/organization-custom-repository-role-example" } } } @@ -15658,8 +15658,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -19908,8 +19909,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -23072,7 +23074,7 @@ }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { - "summary": "List workflow runs", + "summary": "List workflow runs for a workflow", "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" @@ -30276,7 +30278,7 @@ }, "sha": { "type": "string", - "description": "The blob SHA of the file being replaced." + "description": "The blob SHA of the file being deleted." }, "branch": { "type": "string", @@ -83151,7 +83153,7 @@ } ] }, - "organization-custom-repository-role-example-old": { + "organization-custom-repository-role-example": { "value": { "total_count": 2, "custom_roles": [ diff --git a/cache/ghes-3.6.json b/cache/ghes-3.6.json index 4b15db93a..9bbaeed6f 100644 --- a/cache/ghes-3.6.json +++ b/cache/ghes-3.6.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.9.1", + "version": "7.10.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -10081,7 +10081,7 @@ }, "examples": { "default": { - "$ref": "#/components/examples/organization-custom-repository-role-example-old" + "$ref": "#/components/examples/organization-custom-repository-role-example" } } } @@ -10094,7 +10094,13 @@ "category": "orgs", "subcategory": "custom_roles" }, - "x-octokit": {} + "x-octokit": { + "diff": { + "api.github.com": { + "type": "changed" + } + } + } } }, "/orgs/{org}": { @@ -16080,8 +16086,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -20306,8 +20313,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -23568,7 +23576,7 @@ }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { - "summary": "List workflow runs", + "summary": "List workflow runs for a workflow", "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" @@ -30758,7 +30766,7 @@ }, "sha": { "type": "string", - "description": "The blob SHA of the file being replaced." + "description": "The blob SHA of the file being deleted." }, "branch": { "type": "string", @@ -54507,6 +54515,70 @@ } } }, + "/orgs/{org}/custom_roles": { + "post": { + "summary": "Create a custom role", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#create-a-custom-role" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, + "/orgs/{org}/custom_roles/{role_id}": { + "delete": { + "summary": "Delete a custom role", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + }, + "patch": { + "summary": "Update a custom role", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#update-a-custom-role" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, "/orgs/{org}/external-group/{group_id}": { "get": { "summary": "Get an external group", @@ -54573,6 +54645,28 @@ } } }, + "/orgs/{org}/fine_grained_permissions": { + "get": { + "summary": "List fine-grained permissions for an organization", + "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-fine-grained-permissions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, "/orgs/{org}/interaction-limits": { "get": { "summary": "Get interaction restrictions for an organization", @@ -54939,7 +55033,7 @@ }, "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by an organization", + "summary": "List package versions for a package owned by an organization", "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", "tags": [ "packages" @@ -54947,7 +55041,7 @@ "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization" }, "x-octokit": { "api.github.com": "removed" @@ -57422,7 +57516,7 @@ }, "/user/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by the authenticated user", + "summary": "List package versions for a package owned by the authenticated user", "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", "tags": [ "packages" @@ -57430,7 +57524,7 @@ "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" }, "x-octokit": { "api.github.com": "removed" @@ -57678,7 +57772,7 @@ }, "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by a user", + "summary": "List package versions for a package owned by a user", "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com", "tags": [ "packages" @@ -57686,7 +57780,7 @@ "operationId": "packages/get-all-package-versions-for-package-owned-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user" }, "x-octokit": { "api.github.com": "removed" @@ -60863,8 +60957,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default.", - "default": false + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -64970,8 +65065,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Whether a squash merge commit can use the pull request title as default.", - "default": false + "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -87785,7 +87881,7 @@ } ] }, - "organization-custom-repository-role-example-old": { + "organization-custom-repository-role-example": { "value": { "total_count": 2, "custom_roles": [ diff --git a/cache/github.ae.json b/cache/github.ae.json index c6fb634bf..61140bc04 100644 --- a/cache/github.ae.json +++ b/cache/github.ae.json @@ -1,7 +1,7 @@ { "openapi": "3.0.3", "info": { - "version": "7.9.1", + "version": "7.10.0", "title": "GitHub's official OpenAPI spec + Octokit extension", "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { @@ -11541,8 +11541,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -15786,8 +15787,9 @@ }, "use_squash_pr_title_as_default": { "type": "boolean", - "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.", - "default": false + "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.", + "default": false, + "deprecated": true }, "squash_merge_commit_title": { "type": "string", @@ -18140,7 +18142,7 @@ }, "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { "get": { - "summary": "List workflow runs", + "summary": "List workflow runs for a workflow", "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", "tags": [ "actions" @@ -25361,7 +25363,7 @@ }, "sha": { "type": "string", - "description": "The blob SHA of the file being replaced." + "description": "The blob SHA of the file being deleted." }, "branch": { "type": "string", @@ -47466,6 +47468,70 @@ } } }, + "/orgs/{org}/custom_roles": { + "post": { + "summary": "Create a custom role", + "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#create-a-custom-role" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, + "/orgs/{org}/custom_roles/{role_id}": { + "delete": { + "summary": "Delete a custom role", + "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + }, + "patch": { + "summary": "Update a custom role", + "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-custom-role", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#update-a-custom-role" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, "/orgs/{org}/dependabot/secrets": { "get": { "summary": "List organization secrets", @@ -47700,6 +47766,28 @@ } } }, + "/orgs/{org}/fine_grained_permissions": { + "get": { + "summary": "List fine-grained permissions for an organization", + "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-fine-grained-permissions", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization" + }, + "x-octokit": { + "api.github.com": "removed" + }, + "responses": { + "501": { + "description": "Not Implemented" + } + } + } + }, "/orgs/{org}/interaction-limits": { "get": { "summary": "Get interaction restrictions for an organization", @@ -48066,7 +48154,7 @@ }, "/orgs/{org}/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by an organization", + "summary": "List package versions for a package owned by an organization", "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", "tags": [ "packages" @@ -48074,7 +48162,7 @@ "operationId": "packages/get-all-package-versions-for-package-owned-by-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization" }, "x-octokit": { "api.github.com": "removed" @@ -51301,7 +51389,7 @@ }, "/user/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by the authenticated user", + "summary": "List package versions for a package owned by the authenticated user", "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", "tags": [ "packages" @@ -51309,7 +51397,7 @@ "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user" }, "x-octokit": { "api.github.com": "removed" @@ -51601,7 +51689,7 @@ }, "/users/{username}/packages/{package_type}/{package_name}/versions": { "get": { - "summary": "Get all package versions for a package owned by a user", + "summary": "List package versions for a package owned by a user", "description": "This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now.", "tags": [ "packages" @@ -51609,7 +51697,7 @@ "operationId": "packages/get-all-package-versions-for-package-owned-by-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user" + "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user" }, "x-octokit": { "api.github.com": "removed" diff --git a/packages/openapi-types-ghes-3.2/package.json b/packages/openapi-types-ghes-3.2/package.json index 5c1181df7..8bcdb67bb 100644 --- a/packages/openapi-types-ghes-3.2/package.json +++ b/packages/openapi-types-ghes-3.2/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.9.1" + "openapi-version": "7.10.0" } } diff --git a/packages/openapi-types-ghes-3.2/types.d.ts b/packages/openapi-types-ghes-3.2/types.d.ts index c7f0dd222..664d1039f 100644 --- a/packages/openapi-types-ghes-3.2/types.d.ts +++ b/packages/openapi-types-ghes-3.2/types.d.ts @@ -21569,7 +21569,8 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -23573,7 +23574,8 @@ export interface operations { */ allow_update_branch?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -27894,7 +27896,7 @@ export interface operations { "application/json": { /** @description The commit message. */ message: string; - /** @description The blob SHA of the file being replaced. */ + /** @description The blob SHA of the file being deleted. */ sha: string; /** @description The branch name. Default: the repository’s default branch (usually `master`) */ branch?: string; diff --git a/packages/openapi-types-ghes-3.3/package.json b/packages/openapi-types-ghes-3.3/package.json index 1bb6b4824..74cd8effe 100644 --- a/packages/openapi-types-ghes-3.3/package.json +++ b/packages/openapi-types-ghes-3.3/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.9.1" + "openapi-version": "7.10.0" } } diff --git a/packages/openapi-types-ghes-3.3/types.d.ts b/packages/openapi-types-ghes-3.3/types.d.ts index 6bfd1de80..d7d8918c5 100644 --- a/packages/openapi-types-ghes-3.3/types.d.ts +++ b/packages/openapi-types-ghes-3.3/types.d.ts @@ -22249,7 +22249,8 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -24295,7 +24296,8 @@ export interface operations { */ allow_update_branch?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -28763,7 +28765,7 @@ export interface operations { "application/json": { /** @description The commit message. */ message: string; - /** @description The blob SHA of the file being replaced. */ + /** @description The blob SHA of the file being deleted. */ sha: string; /** @description The branch name. Default: the repository’s default branch (usually `master`) */ branch?: string; diff --git a/packages/openapi-types-ghes-3.4/package.json b/packages/openapi-types-ghes-3.4/package.json index 1c5379fcb..5a219a04c 100644 --- a/packages/openapi-types-ghes-3.4/package.json +++ b/packages/openapi-types-ghes-3.4/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.9.1" + "openapi-version": "7.10.0" } } diff --git a/packages/openapi-types-ghes-3.4/types.d.ts b/packages/openapi-types-ghes-3.4/types.d.ts index 5e1c35bb6..ff66ecb59 100644 --- a/packages/openapi-types-ghes-3.4/types.d.ts +++ b/packages/openapi-types-ghes-3.4/types.d.ts @@ -23393,7 +23393,8 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -25471,7 +25472,8 @@ export interface operations { */ allow_update_branch?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -30058,7 +30060,7 @@ export interface operations { "application/json": { /** @description The commit message. */ message: string; - /** @description The blob SHA of the file being replaced. */ + /** @description The blob SHA of the file being deleted. */ sha: string; /** @description The branch name. Default: the repository’s default branch (usually `master`) */ branch?: string; diff --git a/packages/openapi-types-ghes-3.5/package.json b/packages/openapi-types-ghes-3.5/package.json index daf920c1c..220098897 100644 --- a/packages/openapi-types-ghes-3.5/package.json +++ b/packages/openapi-types-ghes-3.5/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.9.1" + "openapi-version": "7.10.0" } } diff --git a/packages/openapi-types-ghes-3.5/types.d.ts b/packages/openapi-types-ghes-3.5/types.d.ts index 294cec2f3..0dbd86ada 100644 --- a/packages/openapi-types-ghes-3.5/types.d.ts +++ b/packages/openapi-types-ghes-3.5/types.d.ts @@ -23963,7 +23963,8 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -26020,7 +26021,8 @@ export interface operations { */ allow_update_branch?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -30906,7 +30908,7 @@ export interface operations { "application/json": { /** @description The commit message. */ message: string; - /** @description The blob SHA of the file being replaced. */ + /** @description The blob SHA of the file being deleted. */ sha: string; /** @description The branch name. Default: the repository’s default branch (usually `master`) */ branch?: string; diff --git a/packages/openapi-types-ghes-3.6/package.json b/packages/openapi-types-ghes-3.6/package.json index 9f906d53d..911f352a9 100644 --- a/packages/openapi-types-ghes-3.6/package.json +++ b/packages/openapi-types-ghes-3.6/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.9.1" + "openapi-version": "7.10.0" } } diff --git a/packages/openapi-types-ghes-3.6/types.d.ts b/packages/openapi-types-ghes-3.6/types.d.ts index 971d454ad..93d97cefc 100644 --- a/packages/openapi-types-ghes-3.6/types.d.ts +++ b/packages/openapi-types-ghes-3.6/types.d.ts @@ -5443,6 +5443,16 @@ export interface paths { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ delete: operations["orgs/remove-saml-sso-authorization"]; }; + "/orgs/{org}/custom_roles": { + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + post: operations["orgs/create-custom-role"]; + }; + "/orgs/{org}/custom_roles/{role_id}": { + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + delete: operations["orgs/delete-custom-role"]; + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + patch: operations["orgs/update-custom-role"]; + }; "/orgs/{org}/external-group/{group_id}": { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ get: operations["teams/external-idp-group-info-for-org"]; @@ -5455,6 +5465,10 @@ export interface paths { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ get: operations["orgs/list-failed-invitations"]; }; + "/orgs/{org}/fine_grained_permissions": { + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + get: operations["orgs/list-fine-grained-permissions"]; + }; "/orgs/{org}/interaction-limits": { /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ get: operations["interactions/get-restrictions-for-org"]; @@ -7530,7 +7544,8 @@ export interface components { */ allow_update_branch?: boolean; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -9657,7 +9672,8 @@ export interface components { */ allow_update_branch?: boolean; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -24962,7 +24978,8 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -27024,7 +27041,8 @@ export interface operations { */ allow_update_branch?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -31993,7 +32011,7 @@ export interface operations { "application/json": { /** @description The commit message. */ message: string; - /** @description The blob SHA of the file being replaced. */ + /** @description The blob SHA of the file being deleted. */ sha: string; /** @description The branch name. Default: the repository’s default branch (usually `master`) */ branch?: string; @@ -42318,6 +42336,27 @@ export interface operations { }; }; /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + "orgs/create-custom-role": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + "orgs/delete-custom-role": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + "orgs/update-custom-role": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ "teams/external-idp-group-info-for-org": { responses: { /** Not Implemented */ @@ -42339,6 +42378,13 @@ export interface operations { }; }; /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ + "orgs/list-fine-grained-permissions": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com */ "interactions/get-restrictions-for-org": { responses: { /** Not Implemented */ diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json index a51789939..58821c526 100644 --- a/packages/openapi-types-github.ae/package.json +++ b/packages/openapi-types-github.ae/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.9.1" + "openapi-version": "7.10.0" } } diff --git a/packages/openapi-types-github.ae/types.d.ts b/packages/openapi-types-github.ae/types.d.ts index 30425e907..99ce42cc0 100644 --- a/packages/openapi-types-github.ae/types.d.ts +++ b/packages/openapi-types-github.ae/types.d.ts @@ -4553,6 +4553,16 @@ export interface paths { /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ delete: operations["orgs/remove-saml-sso-authorization"]; }; + "/orgs/{org}/custom_roles": { + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + post: operations["orgs/create-custom-role"]; + }; + "/orgs/{org}/custom_roles/{role_id}": { + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + delete: operations["orgs/delete-custom-role"]; + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + patch: operations["orgs/update-custom-role"]; + }; "/orgs/{org}/dependabot/secrets": { /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ get: operations["dependabot/list-org-secrets"]; @@ -4589,6 +4599,10 @@ export interface paths { /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ get: operations["orgs/list-failed-invitations"]; }; + "/orgs/{org}/fine_grained_permissions": { + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + get: operations["orgs/list-fine-grained-permissions"]; + }; "/orgs/{org}/interaction-limits": { /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ get: operations["interactions/get-restrictions-for-org"]; @@ -21206,7 +21220,8 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -23241,7 +23256,8 @@ export interface operations { */ allow_update_branch?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -27716,7 +27732,7 @@ export interface operations { "application/json": { /** @description The commit message. */ message: string; - /** @description The blob SHA of the file being replaced. */ + /** @description The blob SHA of the file being deleted. */ sha: string; /** @description The branch name. Default: the repository’s default branch (usually `master`) */ branch?: string; @@ -37140,6 +37156,27 @@ export interface operations { }; }; /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + "orgs/create-custom-role": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + "orgs/delete-custom-role": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + "orgs/update-custom-role": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ "dependabot/list-org-secrets": { responses: { /** Not Implemented */ @@ -37217,6 +37254,13 @@ export interface operations { }; }; /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ + "orgs/list-fine-grained-permissions": { + responses: { + /** Not Implemented */ + 501: unknown; + }; + }; + /** This endpoint is currently not supported by GitHub AE. It only exists in api.github.com right now. */ "interactions/get-restrictions-for-org": { responses: { /** Not Implemented */ diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json index 4032388de..227216988 100644 --- a/packages/openapi-types/package.json +++ b/packages/openapi-types/package.json @@ -15,6 +15,6 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "octokit": { - "openapi-version": "7.9.1" + "openapi-version": "7.10.0" } } diff --git a/packages/openapi-types/types.d.ts b/packages/openapi-types/types.d.ts index 449916db5..dc09de06a 100644 --- a/packages/openapi-types/types.d.ts +++ b/packages/openapi-types/types.d.ts @@ -1265,6 +1265,44 @@ export interface paths { */ delete: operations["orgs/remove-saml-sso-authorization"]; }; + "/orgs/{org}/custom_roles": { + /** + * **Note**: This operation is in beta and is subject to change. + * + * Creates a custom repository role that can be used by all repositories owned by the organization. + * + * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope. + * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint. + * + * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." + */ + post: operations["orgs/create-custom-role"]; + }; + "/orgs/{org}/custom_roles/{role_id}": { + /** + * **Note**: This operation is in beta and is subject to change. + * + * Deletes a custom role from an organization. Once the custom role has been deleted, any + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. + * + * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope. + * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint. + * + * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." + */ + delete: operations["orgs/delete-custom-role"]; + /** + * **Note**: This operation is in beta and subject to change. + * + * Updates a custom repository role that can be used by all repositories owned by the organization. + * + * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope. + * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint. + * + * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." + */ + patch: operations["orgs/update-custom-role"]; + }; "/orgs/{org}/dependabot/secrets": { /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ get: operations["dependabot/list-org-secrets"]; @@ -1392,6 +1430,17 @@ export interface paths { /** The return hash contains `failed_at` and `failed_reason` fields which represent the time at which the invitation failed and the reason for the failure. */ get: operations["orgs/list-failed-invitations"]; }; + "/orgs/{org}/fine_grained_permissions": { + /** + * **Note**: This operation is in beta and subject to change. + * + * Lists the fine-grained permissions available for an organization. + * + * To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope. + * GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint. + */ + get: operations["orgs/list-fine-grained-permissions"]; + }; "/orgs/{org}/hooks": { get: operations["orgs/list-webhooks"]; /** Here's how you can create a hook that posts payloads in JSON format: */ @@ -1620,7 +1669,7 @@ export interface paths { }; "/orgs/{org}/packages/{package_type}/{package_name}/versions": { /** - * Returns all package versions for a package owned by an organization. + * Lists package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. @@ -6135,7 +6184,7 @@ export interface paths { }; "/user/packages/{package_type}/{package_name}/versions": { /** - * Returns all package versions for a package owned by the authenticated user. + * Lists package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. @@ -6364,7 +6413,7 @@ export interface paths { }; "/users/{username}/packages/{package_type}/{package_name}/versions": { /** - * Returns all package versions for a public package owned by a specified user. + * Lists package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. @@ -7748,7 +7797,8 @@ export interface components { */ allow_update_branch?: boolean; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10254,7 +10304,8 @@ export interface components { */ allow_update_branch?: boolean; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -10584,6 +10635,20 @@ export interface components { id: number; /** @description The name of the custom role. */ name: string; + /** @description A short description about who this role is for or what permissions it grants. */ + description?: string | null; + /** + * @description The system role from which this role inherits permissions. + * @enum {string} + */ + base_role?: "read" | "triage" | "write" | "maintain"; + /** @description A list of additional permissions included in this role. */ + permissions?: string[]; + organization?: components["schemas"]["simple-user"]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; }; /** * Organization Full @@ -11339,6 +11404,14 @@ export interface components { /** @example "https://api.github.com/organizations/16/invitations/1/teams" */ invitation_teams_url: string; }; + /** + * Organization Fine-Grained Permission + * @description Fine-grained permissions available for the organization + */ + "organization-fine-grained-permission": { + name: string; + description: string; + }; /** * Org Hook * @description Org Hook @@ -20232,6 +20305,8 @@ export interface components { "secret-name": string; /** @description The handle for the GitHub user account. */ username: string; + /** @description The unique identifier of the role. */ + "role-id": number; /** @description The unique identifier of the group. */ "group-id": number; /** @description The unique identifier of the hook. */ @@ -25118,6 +25193,123 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * **Note**: This operation is in beta and is subject to change. + * + * Creates a custom repository role that can be used by all repositories owned by the organization. + * + * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope. + * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint. + * + * For more information on custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." + */ + "orgs/create-custom-role": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 201: { + content: { + "application/json": components["schemas"]["organization-custom-repository-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the custom role. */ + name: string; + /** @description A short description about the intended usage of this role or what permissions it grants. */ + description?: string; + /** + * @description The system role from which this role inherits permissions. + * @enum {string} + */ + base_role: "read" | "triage" | "write" | "maintain"; + /** @description A list of additional permissions included in this role. */ + permissions: string[]; + }; + }; + }; + }; + /** + * **Note**: This operation is in beta and is subject to change. + * + * Deletes a custom role from an organization. Once the custom role has been deleted, any + * user, team, or invitation with the deleted custom role will be reassigned the inherited role. + * + * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope. + * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint. + * + * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." + */ + "orgs/delete-custom-role": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** Response */ + 204: never; + }; + }; + /** + * **Note**: This operation is in beta and subject to change. + * + * Updates a custom repository role that can be used by all repositories owned by the organization. + * + * To use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope. + * GitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint. + * + * For more information about custom repository roles, see "[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)." + */ + "orgs/update-custom-role": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** The unique identifier of the role. */ + role_id: components["parameters"]["role-id"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-custom-repository-role"]; + }; + }; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the custom role. */ + name?: string; + /** @description A short description about who this role is for or what permissions it grants. */ + description?: string; + /** + * @description The system role from which this role inherits permissions. + * @enum {string} + */ + base_role?: "read" | "triage" | "write" | "maintain"; + /** @description A list of additional permissions included in this role. If specified, these permissions will replace any currently set on the role. */ + permissions?: string[]; + }; + }; + }; + }; /** Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. */ "dependabot/list-org-secrets": { parameters: { @@ -25499,6 +25691,30 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + /** + * **Note**: This operation is in beta and subject to change. + * + * Lists the fine-grained permissions available for an organization. + * + * To use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope. + * GitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint. + */ + "orgs/list-fine-grained-permissions": { + parameters: { + path: { + /** The organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + }; + responses: { + /** Response */ + 200: { + content: { + "application/json": components["schemas"]["organization-fine-grained-permission"][]; + }; + }; + }; + }; "orgs/list-webhooks": { parameters: { path: { @@ -26692,7 +26908,7 @@ export interface operations { }; }; /** - * Returns all package versions for a package owned by an organization. + * Lists package versions for a package owned by an organization. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. @@ -27092,7 +27308,8 @@ export interface operations { */ delete_branch_on_merge?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -29526,7 +29743,8 @@ export interface operations { */ allow_update_branch?: boolean; /** - * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. + * @deprecated + * @description Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default?: boolean; @@ -35159,7 +35377,7 @@ export interface operations { "application/json": { /** @description The commit message. */ message: string; - /** @description The blob SHA of the file being replaced. */ + /** @description The blob SHA of the file being deleted. */ sha: string; /** @description The branch name. Default: the repository’s default branch (usually `master`) */ branch?: string; @@ -46378,7 +46596,7 @@ export interface operations { }; }; /** - * Returns all package versions for a package owned by the authenticated user. + * Lists package versions for a package owned by the authenticated user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope. @@ -47509,7 +47727,7 @@ export interface operations { }; }; /** - * Returns all package versions for a public package owned by a specified user. + * Lists package versions for a public package owned by a specified user. * * To use this endpoint, you must authenticate using an access token with the `packages:read` scope. * If `package_type` is not `container`, your token must also include the `repo` scope.